Link docs index section headings to their section index pages - #2566
Open
rinceyuan wants to merge 1 commit into
Open
Link docs index section headings to their section index pages#2566rinceyuan wants to merge 1 commit into
rinceyuan wants to merge 1 commit into
Conversation
Troubleshooting, Observability and Integrations pointed at an individual page instead of the section README, unlike Setup, Authentication, Features and Hooks. As a result docs/integrations/README.md and docs/troubleshooting/README.md were not reachable from anywhere in the repository.
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
All updated links resolve to the intended existing index pages.
Pull request overview
Updates the documentation map so section headings consistently link to their index pages.
Changes:
- Links Troubleshooting, Observability, and Integrations headings to their section indexes.
- Makes previously orphaned index pages discoverable.
File summaries
| File | Description |
|---|---|
docs/README.md |
Updates three section heading links. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
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.
In
docs/README.md, most section headings link to that section's index page, but three link to an individual article instead. Two of those sections have an index that nothing links to as a result../setup/README.md./auth/README.md./features/README.md./hooks/README.md./troubleshooting/debugging.md./observability/opentelemetry.md./integrations/microsoft-agent-framework.mddocs/integrations/README.mdanddocs/troubleshooting/README.mdwere unreachable — nothing in the repository linked to them:Both are real index pages, not placeholders —
troubleshooting/README.mdlists all three troubleshooting articles, andintegrations/README.mdlists the integrations guide.Verification
All seven section headings now resolve to a file that exists, and the two orphans are linked:
Notes
Observability was not orphaned —
docs/features/usage-and-billing.mdlinks its index — but its heading deviated from the same convention, so it is included here for consistency.Two things deliberately left alone:
./troubleshooting/debugging.md. That table is task-oriented, so linking the article rather than the index looks intentional.docs/developer-docs/secrets.mdis also unlinked, but it documents Actions secrets for maintainers rather than being part of the user-facing navigation.