Improves the default template for TypeScript documentation

[rbuckton]

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-documenter package in microsoft/rushstack#1537.

• Add TypeScript namespaces, type aliases, and exported variables to the default template:
  
• Fixes Inheritance hierarchy rendering:
  
• Adds entries for the current TypeScript namespace (if one was recorded), and the containing package:
  

Microsoft Reviewers: Open in CodeFlow

[dnfclas]

All CLA requirements met.

[octogonz]

Awesome, thanks for making this PR! We've been waiting for this DocFX improvement for a long time.

[octogonz]

@AlexJerabek FYI

[octogonz]

@dend @OsmondJiang @yufeih

I noticed the v2 tag. Just curious, what's the usual timeframe for releasing a template update?

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]

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.

[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. 😊

[yufeih]

@octogonz that make sense.

[rbuckton]

@yufeih Does the DocFX project publish nightly builds?

[yufeih]

yep, here is the feed: https://www.myget.org/feed/Packages/docfx-dev