docs: rename index.md to README.md in docs directories#1631
Merged
Conversation
Rename all index.md files to README.md so directory contents are rendered automatically when browsing folders on GitHub.com. Update all internal cross-references accordingly. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR renames the docs/**/index.md landing pages to README.md so GitHub renders each docs section automatically when browsing directories, and updates internal links accordingly.
Changes:
- Updated root
README.mdanddocs/**/*.mdcross-references to point to the newdocs/**/README.mdlanding pages. - Added/updated section landing pages under
docs/(setup, auth, features, hooks, integrations, observability, troubleshooting). - Adjusted “See also”/navigation links in several docs pages to match the new README-based structure.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates doc links to target docs/**/README.md landing pages. |
| docs/README.md | Updates the main docs landing page to point at section README.md files. |
| docs/setup/README.md | Adds a setup section landing page for directory rendering. |
| docs/troubleshooting/README.md | Adds a troubleshooting section landing page for directory rendering. |
| docs/observability/README.md | Adds an observability section landing page for directory rendering. |
| docs/integrations/README.md | Adds an integrations section landing page for directory rendering. |
| docs/hooks/README.md | Adds a hooks reference landing page for directory rendering. |
| docs/features/README.md | Updates feature index references to the new hooks landing page path. |
| docs/auth/README.md | Adds an authentication landing page for directory rendering. |
| docs/setup/multi-tenancy.md | Updates “See also” link to the features landing page path. |
| docs/hooks/user-prompt-submitted.md | Updates “See also” link to ./README.md. |
| docs/hooks/session-lifecycle.md | Updates “See also” link to ./README.md. |
| docs/hooks/pre-tool-use.md | Updates “See also” link to ./README.md. |
| docs/hooks/post-tool-use.md | Updates “See also” link to ./README.md. |
| docs/hooks/error-handling.md | Updates “See also” link to ./README.md. |
| docs/features/cloud-sessions.md | Updates authentication link to the new auth landing page path. |
| docs/auth/byok.md | Updates “Next steps” link to the new auth landing page path. |
Copilot's findings
Comments suppressed due to low confidence (1)
docs/README.md:12
- This PR removes all
docs/**/index.mdfiles by renaming them toREADME.md. However, the repo’s docs style guide states that in the docs pipeline,index.mdfiles are treated as YAML-only category pages for docs.github.com. If theseindex.mdcategory pages are still required for the sync/navigation pipeline, renaming them away will likely break that pipeline. Consider keepingindex.md(YAML-only) for the pipeline and addingREADME.mdfor GitHub directory rendering, or otherwise updating the pipeline to recognizeREADME.mdas the category page entrypoint.
- Files reviewed: 11/17 changed files
- Comments generated: 2
Comment on lines
+510
to
512
| - [Hooks Overview](./README.md) | ||
| - [Pre-Tool Use Hook](./pre-tool-use.md) | ||
| - [Error Handling Hook](./error-handling.md) No newline at end of file |
Comment on lines
+615
to
616
| * [Authentication Overview](./README.md) - Learn about all authentication methods | ||
| * [Getting Started Guide](../getting-started.md) - Build your first Copilot-powered app |
criemen
approved these changes
Jun 11, 2026
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
Renames all
index.mdfiles underdocs/toREADME.mdso that GitHub.com automatically renders them when browsing each directory.Changes
docs/index.md,docs/auth/index.md,docs/features/index.md,docs/hooks/index.md,docs/integrations/index.md,docs/observability/index.md,docs/setup/index.md,docs/troubleshooting/index.md→ each correspondingREADME.mddocs/**/*.mdand rootREADME.mdto point toREADME.mdinstead ofindex.mdMotivation
GitHub renders
README.mdfiles automatically when you visit a directory on GitHub.com. Usingindex.mdrequires an explicit file click, which makes the docs less discoverable when browsing the repo.