-
-
Notifications
You must be signed in to change notification settings - Fork 75
Add API Documenter and generate API documentation for shared libs #1216
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
romainmenke
merged 22 commits into
main
from
documentation-for-packages--diligent-cheetah-7c39e64106
Dec 26, 2023
Merged
Add API Documenter and generate API documentation for shared libs #1216
romainmenke
merged 22 commits into
main
from
documentation-for-packages--diligent-cheetah-7c39e64106
Dec 26, 2023
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…' of https://github.com/csstools/postcss-plugins into documentation-for-packages--diligent-cheetah-7c39e64106
…kages--diligent-cheetah-7c39e64106
…kages--diligent-cheetah-7c39e64106
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I've enabled
api-documenter
which is build on top of the API analysis ofapi-extractor
for all the shared libraries underpackages/
.I've been playing with the documentation a bit but I don't want to write too much docs at this time.
I think it's better to first have a system for API docs and then work on content later.
see : #1201
interesting pages :
api-documenter
markdown output results in a massive number of files for packages like the media query parser. This is a combination of the size of the API and thatapi-documenter
makes a page for each bit of API. So a class field will have its own page.I don't know why, but I expected there to be less output, but I guess this is mostly exposing existing complexity. Packages like the color helpers, tokenizer, parsers are just really large.
I am not sure if I have a strong opinion on this and want to see how it evolves.