docs: restore the library README on GitHub - #268
Merged
Merged
Conversation
There was a problem hiding this comment.
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
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
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 rootREADME.mdon the repository overview. This hides the library documentation and badges, including the coverage link added for awesome-go.What changed
.github/README.mdto.github/AUTOMATION.md, with no content changes.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.Summary by cubic
Restores the library README as the repository overview by renaming
.github/README.mdto.github/AUTOMATION.md. GitHub gives.github/README.mdpriority over the rootREADME.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.