Skip to content

docs: restore the library README on GitHub - #268

Merged
TristanSpeakEasy merged 1 commit into
mainfrom
docs/restore-repository-readme
Oct 6, 2026
Merged

TristanSpeakEasy merged 1 commit into
mainfrom
docs/restore-repository-readme

Conversation

@TristanSpeakEasy

@TristanSpeakEasy TristanSpeakEasy commented Oct 6, 2026 •

Copy link
Copy Markdown
Member

Why

GitHub is showing the repository automation notes instead of the library README. #265 added .github/README.md, and GitHub gives that file priority over the root README.md on the repository overview. This hides the library documentation and badges, including the coverage link added for awesome-go.

What changed

  • Renamed .github/README.md to .github/AUTOMATION.md, with no content changes.
  • Kept the notes in the same directory so their relative workflow link still works.
  • Left the root README and coverage badge unchanged.

Review notes

This is an exact file rename. No workflow, application, test or dependency changes are included.

Testing

  • mise ci: passed locally.
  • git diff --cached origin/main --check: passed using the isolated delivery index.
  • Confirmed the renamed file has the same Git blob hash as the original.
  • GitHub's repository overview can be checked after this PR merges.

Summary by cubic

Restores the library README as the repository overview by renaming .github/README.md to .github/AUTOMATION.md. GitHub gives .github/README.md priority over the root README.md, which was hiding the library documentation and badges.

This is an exact file rename: the automation notes stay in .github/ so their relative workflow link still works, and the root README and coverage badge are unchanged.

Written for commit 02248a9. Summary will update on new commits.

Review in cubic

@TristanSpeakEasy
TristanSpeakEasy requested a review from a team as a code owner October 6, 2026 00:30

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

No issues found across 1 file

Confidence score: 5/5

  • Automated review surfaced no issues in the provided summaries.
  • No files require special attention.

Shadow auto-approve: would auto-approve. Renames the automation notes without content changes, restoring the root README as the repository overview. Documentation-only; no code or configuration impact.

Re-trigger cubic

@TristanSpeakEasy
TristanSpeakEasy merged commit cb82fbf into main Oct 6, 2026
5 checks passed
@TristanSpeakEasy
TristanSpeakEasy deleted the docs/restore-repository-readme branch October 6, 2026 00:32
@codecov

codecov Bot commented Oct 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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.

1 participant