Repository navigation
README: lead with the project name, move upgrade notes to UPGRADING.md - #642
Merged
Merged
Conversation
Search engines were using the 0.7.0 plugin upgrade note as the repo's snippet because it was the most name-dense passage on the page. Open the README with a sentence that names and describes GoBlog, move the per-release upgrade notes into UPGRADING.md, and point the build and coverage badges at goblogplatform/goblog instead of the old org. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
It is a docs-only change whose moved content, cross-file anchors, badge URLs, and absence of dangling references were all verified as correct.
Review effort: Balanced
Findings: None
What changed in this PR
This is a documentation-only PR aimed at improving the repository's search-engine snippet and discoverability. It rewrites the README's opening so the project name ("GoBlog") and a descriptive sentence lead the page, extracts the release-specific upgrade notes into a dedicated UPGRADING.md, and repoints the build/codecov badges from compscidr/goblog to the new goblogplatform/goblog location.
Changes:
- README now opens with
# GoBlogand a descriptive sentence, plus a link to the newUPGRADING.md. - The three upgrade notes (0.7.0 themes, 0.7.0 plugins, 0.3.0 scholar) move verbatim into
UPGRADING.md, with their directory links rewritten as cross-fileREADME.md#installing-from-the-directoryanchors. - Build and codecov badge URLs switch to
goblogplatform/goblog.
| File | Description |
|---|---|
| README.md | Renames heading to GoBlog, adds a descriptive lead line and an UPGRADING.md link, updates badge URLs, and removes the inline upgrade notes. |
| UPGRADING.md | New file collecting the 0.7.0 and 0.3.0 upgrade notes (newest first), with directory links pointing back to the README anchor. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
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
Searching Bing for "goblog" shows this repo with the 0.7.0 plugin upgrade note as its snippet instead of a description. That paragraph was the most "goblog"-dense passage on the page, while the README's opening line never mentioned the project name.
What
goblogtoGoBlog).UPGRADING.md, linked from the top of the README. Their#installing-from-the-directorylinks now point back at the README.goblogplatform/gobloginstead ofcompscidr/goblog(both new URLs return 200).Not changed: the
compscidr/goblogDocker image name and the in-container/go/src/github.com/compscidr/goblogpaths, which are still what the Dockerfile and release workflows use.Docs only; no code changes.
🤖 Generated with Claude Code