Skip to content

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

Conversation

romainmenke
Copy link
Member

@romainmenke romainmenke commented Dec 16, 2023

I've enabled api-documenter which is build on top of the API analysis of api-extractor for all the shared libraries under packages/.

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 that api-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.

@romainmenke romainmenke marked this pull request as ready for review December 16, 2023 16:15
@romainmenke romainmenke merged commit 1569895 into main Dec 26, 2023
@romainmenke romainmenke deleted the documentation-for-packages--diligent-cheetah-7c39e64106 branch December 26, 2023 21:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant