Skip to content

docs: Stop GitHub from surfacing .github README - #23

Merged
rahulbsw merged 1 commit into
mainfrom
docs/github-home-readme-fix
May 24, 2026
Merged

docs: Stop GitHub from surfacing .github README#23
rahulbsw merged 1 commit into
mainfrom
docs/github-home-readme-fix

Conversation

@rahulbsw

Copy link
Copy Markdown
Owner

Summary

  • rename .github/README.md to .github/MAINTAINERS.md
  • keep the same maintainer-facing guidance under a non-public-facing filename

Why

GitHub is surfacing .github/README.md on the repository Code page instead of the root README.md. Renaming the file removes that conflict so the product-facing root README becomes the landing content again.

Validation

  • verified the live repo homepage was rendering .github/README.md
  • git diff --check

@rahulbsw rahulbsw added documentation Improvements or additions to documentation security Security-related changes skip-size-check Bypass PR size check for intentionally large PRs labels May 24, 2026
@rahulbsw
rahulbsw merged commit e17190e into main May 24, 2026
66 checks passed
@rahulbsw
rahulbsw deleted the docs/github-home-readme-fix branch July 25, 2026 22:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/core ci/cd documentation Improvements or additions to documentation security Security-related changes size/XS skip-size-check Bypass PR size check for intentionally large PRs version/patch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant