Skip to content

Link docs index section headings to their section index pages - #2566

Open
rinceyuan wants to merge 1 commit into
github:mainfrom
rinceyuan:docs/section-index-links
Open

Link docs index section headings to their section index pages#2566
rinceyuan wants to merge 1 commit into
github:mainfrom
rinceyuan:docs/section-index-links

Conversation

@rinceyuan

Copy link
Copy Markdown
Contributor

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.

Heading Linked to Section index
Setup ./setup/README.md
Authentication ./auth/README.md
Features ./features/README.md
Hooks Reference ./hooks/README.md
Troubleshooting ./troubleshooting/debugging.md ❌ index exists, unlinked
Observability ./observability/opentelemetry.md ❌ index exists
Integrations ./integrations/microsoft-agent-framework.md ❌ index exists, unlinked

docs/integrations/README.md and docs/troubleshooting/README.md were unreachable — nothing in the repository linked to them:

$ git grep -rn -E 'integrations/README\.md|troubleshooting/README\.md'
                      # (no output, before this change)

Both are real index pages, not placeholders — troubleshooting/README.md lists all three troubleshooting articles, and integrations/README.md lists the integrations guide.

Verification

All seven section headings now resolve to a file that exists, and the two orphans are linked:

$ git grep -rn -E 'integrations/README\.md|troubleshooting/README\.md'
docs/README.md:70:### [Troubleshooting](./troubleshooting/README.md)
docs/README.md:80:### [Integrations](./integrations/README.md)

$ ls docs/troubleshooting/README.md docs/observability/README.md docs/integrations/README.md
docs/troubleshooting/README.md  docs/observability/README.md  docs/integrations/README.md

Notes

Observability was not orphaned — docs/features/usage-and-billing.md links its index — but its heading deviated from the same convention, so it is included here for consistency.

Two things deliberately left alone:

  • The Debug an issue row in the quick-start table still points at ./troubleshooting/debugging.md. That table is task-oriented, so linking the article rather than the index looks intentional.
  • docs/developer-docs/secrets.md is also unlinked, but it documents Actions secrets for maintainers rather than being part of the user-facing navigation.

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.
Copilot AI balanced review requested due to automatic review settings September 8, 2026 02:18
@rinceyuan
rinceyuan requested a review from a team as a code owner September 8, 2026 02:18

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants