-
Notifications
You must be signed in to change notification settings - Fork 13
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
Generate API documentation for all packages #135
Comments
This has become especially relevant now that we've published all packages to GitHub; it should be easy for consumers to discover the different packages and the APIs they expose. API Extractor currently seems like the best candidate, but is still not a viable option due to the reasons listed above. Also, we should keep an eye on TypeStrong/typedoc#1266. |
Work on this is being tracked in #290. |
To ease the entry cost into Alfa, we could group packages by similar areas of interests. I see 4-5 groups currently:
Having such high-level grouping could help navigating the 80 packages we have… Typically, it is fairly obvious (from the name) what Not sure how this fits in auto-generated doc. Maybe this could be auto-generated from package description? |
Approaches tested so far:
TypeDoc. Currently not possible due to: Support "build" mode (multi project) Typescript TypeStrong/typedoc#923
Documentation.js. Seems to straight up not work.
API Extractor. Currently not possible due to: [api-extractor] Support "import * as __ from __" for local paths microsoft/rushstack#1029. Also does not support merged namespaces, which we use quite a bit.
Compodoc. Does not support generating Markdown output.
The text was updated successfully, but these errors were encountered: