Automate API toc.yml generation in DocFX#1645
Merged
clairernovotny merged 3 commits intouse-docfxfrom Nov 6, 2025
Merged
Conversation
Co-authored-by: clairernovotny <[email protected]>
Co-authored-by: clairernovotny <[email protected]>
Copilot
AI
changed the title
[WIP] Address feedback on migrating docs site to DocFX
Automate API toc.yml generation in DocFX
Nov 6, 2025
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR transitions the API documentation table of contents from a manually maintained file to an automatically generated one. The change removes the static docs/api/toc.yml file (containing 388 lines of manually tracked API entries) and updates the DocFX configuration to enable automatic generation during the build process.
Key Changes:
- Removed the DocFX exclude rule that prevented auto-generation of
api/toc.yml - Deleted the manually maintained 388-line
docs/api/toc.ymlfile - Updated documentation to clarify that the table of contents is auto-generated and stays in sync with the codebase
Reviewed Changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/docfx.json |
Removed the exclude property that was preventing auto-generation of api/toc.yml |
docs/api/toc.yml |
Deleted the entire manually maintained table of contents file (388 lines) |
docs/api/index.md |
Enhanced documentation to explain that the API reference and TOC are auto-generated using DocFX |
.gitignore |
Removed the exception rule for docs/api/toc.yml, allowing it to be ignored like other auto-generated YAML files |
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
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.
Addresses feedback from #1642 to automate the API table of contents generation and ensure documentation stays synchronized with code changes.
Changes
docs/api/toc.yml- DocFX now generates this automatically during the metadata phase based on assembly structure.gitignore- Removed exception fordocs/api/toc.ymlso all API YAML files are treated as generated artifactsdocs/docfx.json- Removed exclusion ofapi/toc.ymlfrom build content to allow auto-generated file to be useddocs/api/index.md- Documented that the API reference is now fully auto-generatedThe API navigation structure will now automatically reflect any new types, namespaces, or members added to the codebase without manual intervention.
Note: The docfx tool existence check mentioned in the feedback was already addressed in commit ca4b984 of #1642.
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.