Update docs generation to populate correct docs, remove redundant docs #1634
Conversation
There was a problem hiding this comment.
Pull request overview
This PR consolidates documentation by removing the redundant docs/deprecated-tool-aliases.md file and updating the documentation generation system to populate the docs/tool-renaming.md file instead. The tool-renaming guide already contained all the relevant information about the deprecation alias system, making the separate deprecated-tool-aliases document unnecessary.
Key changes:
- Adds a "Current Deprecations" section to
docs/tool-renaming.mdwith automated markers for auto-generation - Deletes the redundant
docs/deprecated-tool-aliases.mdfile completely - Updates the docs generation configuration to target
docs/tool-renaming.mdinstead of the deleted file
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/tool-renaming.md | Adds "Current Deprecations" section with automated alias table markers to support auto-generation |
| docs/deprecated-tool-aliases.md | Removes redundant file - all content already covered in tool-renaming.md |
| cmd/github-mcp-server/generate_docs.go | Updates generateAllDocs to generate docs for tool-renaming.md instead of deprecated-tool-aliases.md |
Note: While reviewing this PR, I noticed that README.md line 387 still references docs/deprecated-tool-aliases.md. This file is not part of the PR changes, but the link will be broken after this PR is merged and should be updated to point to docs/tool-renaming.md instead. Consider addressing this in a follow-up change or as part of running script/generate-docs after this PR is merged.
Summary
This PR removes the redundant
deprecated-tool-aliases.mdas we already havetool-renaming.mdand it also ensures that the autogeneration of docs populates thetool-renaming.mddocs when generating the table for tool aliasesTested locally
Why
Fixes duplicate docs issue
What changed
tool-renaming.md)MCP impact
Prompts tested (tool changes only)
n/a
Security / limits
Lint & tests
./script/lint./script/testDocs