Conversation
- Move generated file from docs/TOOLS.md to docs/tools/api-reference.md - Update sidebar link from /TOOLS to /tools/api-reference - Remove /TOOLS from ignoreDeadLinks (no longer needed) - Hide edit link for generated api-reference.md page - Update documentation and CLI help text references Closes #303
Test Coverage ReportOverall Coverage: 95.77%
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
There was a problem hiding this comment.
Pull request overview
This PR fixes a VitePress sidebar navigation issue where the auto-generated tool reference page at /TOOLS wasn't displaying the sidebar. The root cause was that VitePress uses path prefix matching, and the sidebar was configured for /tools/ but the file was at the root level as /TOOLS. The fix moves the generated file into the /tools/ directory with a clearer name.
Changes:
- Move generated API reference from
docs/TOOLS.mdtodocs/tools/api-reference.md - Update all documentation and CLI help references to point to the new path
- Remove
/TOOLSfrom VitePressignoreDeadLinksconfiguration and hide edit link for the generated file
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| .github/workflows/docs.yml | Update docs build workflow to generate file at new path |
| README.md.in | Update command examples and link to use new path |
| docs/.vitepress/config.mts | Update sidebar link, remove dead link exception, hide edit link for generated file |
| docs/cli/list-tools.md | Update all command examples to use new path |
| docs/tools/index.md.in | Update documentation link and generation command |
| src/cli/list-tools.ts | Update CLI help text and examples to reference new path |
polaz
deleted the
fix/#303-docs-tools-page-missing-sidebar--path-mismatch
branch
|
🎉 This PR is included in version 6.58.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
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.
Summary
docs/TOOLS.mdtodocs/tools/api-reference.md/TOOLSto/tools/api-reference/TOOLSfromignoreDeadLinks(no longer needed)api-reference.mdpageProblem
The
/TOOLSpage was missing sidebar navigation because VitePress sidebar uses path prefix matching. The sidebar was defined for/tools/but the file was at/TOOLS(root level, uppercase).Solution
Move the generated file into the
/tools/directory so it inherits the sidebar configuration.Closes #303