Skip to content

docs: rename index.md to README.md in docs directories#1631

Merged
andyfeller merged 1 commit into
mainfrom
docs/rename-index-to-readme
Jun 11, 2026
Merged

docs: rename index.md to README.md in docs directories#1631
andyfeller merged 1 commit into
mainfrom
docs/rename-index-to-readme

Conversation

@andyfeller

@andyfeller andyfeller commented Jun 11, 2026

Copy link
Copy Markdown
Contributor

Summary

Renames all index.md files under docs/ to README.md so that GitHub.com automatically renders them when browsing each directory.

Screenshot 2026-06-11 at 9 14 58 AM

Changes

  • Renamed 8 files: 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 corresponding README.md
  • Updated all internal cross-references in docs/**/*.md and root README.md to point to README.md instead of index.md

Motivation

GitHub renders README.md files automatically when you visit a directory on GitHub.com. Using index.md requires an explicit file click, which makes the docs less discoverable when browsing the repo.

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>
@andyfeller andyfeller requested a review from a team as a code owner June 11, 2026 13:12
Copilot AI review requested due to automatic review settings June 11, 2026 13:12

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.

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.md and docs/**/*.md cross-references to point to the new docs/**/README.md landing 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.md files by renaming them to README.md. However, the repo’s docs style guide states that in the docs pipeline, index.md files are treated as YAML-only category pages for docs.github.com. If these index.md category pages are still required for the sync/navigation pipeline, renaming them away will likely break that pipeline. Consider keeping index.md (YAML-only) for the pipeline and adding README.md for GitHub directory rendering, or otherwise updating the pipeline to recognize README.md as 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 thread docs/auth/byok.md
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
@andyfeller andyfeller added this pull request to the merge queue Jun 11, 2026
Merged via the queue into main with commit 810bbbf Jun 11, 2026
16 checks passed
@andyfeller andyfeller deleted the docs/rename-index-to-readme branch June 11, 2026 13:25
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.

3 participants