-
Notifications
You must be signed in to change notification settings - Fork 877
Improves the default template for TypeScript documentation #5128
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
Conversation
|
Awesome, thanks for making this PR! We've been waiting for this DocFX improvement for a long time. |
|
@AlexJerabek FYI |
|
I noticed the For some context, DocFX's handling of TypeScript namespaces has been an issue for libraries like Office Add-ins and Office UI Fabric for a long time. This PR is the second-to-last in a series of PRs that @rbuckton has been working on over the summer, which should finally solve this problem. We're really excited about it! But we can't merge microsoft/rushstack#1537 until the fixed template has been released. |
yufeih
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍👍
@octogonz , you mentioned this is the second-to-last PR, once all the PRs are merged, we can release an update of docfx. Release train ships every 3 weeks or so.
The other PRs aren't for the DocFX project. They are for API Extractor, which is the tool that Office uses to generate the .yml input files for DocFX. The last PR microsoft/rushstack#1537 will update API Extractor to generate .yml files for namespaces, which requires the updated template from this PR. (Thus it is blocked until this PR gets merged+released.) Sorry, I guess I could have explained that better. 😊 |
|
@octogonz that make sense. |
|
@yufeih Does the DocFX project publish nightly builds? |
This PR makes a few changes to the default template to fix some issues and better support TypeScript documentation. This PR is also intended to align with the changes to the
@microsoft/api-documenterpackage in microsoft/rushstack#1537.Microsoft Reviewers: Open in CodeFlow