docs: fix GoFr brand casing in nav descriptions and search breadcrumbs#216
Closed
aryanmehrotra wants to merge 1 commit into
Closed
docs: fix GoFr brand casing in nav descriptions and search breadcrumbs#216aryanmehrotra wants to merge 1 commit into
aryanmehrotra wants to merge 1 commit into
Conversation
The lowercase 'r' is the canonical brand mark (matches the logo).
Two website-side spots had drifted to "GoFR" (all-caps R) or
"Gofr" (lowercase 'ofr'):
- src/lib/navigation.js — 7 desc strings used 'GoFR' through-out
the nav. This is the website's standalone copy of nav metadata;
the framework's gofr/docs/navigation.js overlays it during the
framework-docs docker build, so when paired with gofr#3398 the
fix lands in both layers.
- src/components/Search.jsx — `prettifySegment` was naive Title
Case, so search breadcrumbs rendered slugs like 'gofr-vs-gin'
as 'Gofr Vs Gin' and 'wrap-grpc' as 'Wrap Grpc'. Added a small
PRETTY_TOKENS map (gofr → GoFr, gofrcli → GoFr CLI, vs → vs,
grpc → gRPC, etc.) so the breadcrumb honors the brand mark and
common acronyms while plain words still fall through to Title
Case.
Code identifiers left alone (RegisterServerWithGofr, GOFR_TELEMETRY).
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the website’s docs navigation copy and search-result breadcrumbs to use correct GoFr brand casing and better formatting for common slug tokens (brand + acronyms), improving consistency across the docs UX.
Changes:
- Replaced “GoFR” with canonical “GoFr” in multiple navigation description strings.
- Enhanced search breadcrumb segment prettifying with a token map (e.g.,
gofr→ “GoFr”,grpc→ “gRPC”,vs→ “vs”) while keeping a Title Case fallback.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/lib/navigation.js | Normalizes brand casing in navigation metadata descriptions shown across docs navigation/search context. |
| src/components/Search.jsx | Improves breadcrumb rendering by mapping known tokens (brand/acronyms) instead of naive Title Case. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
3 tasks
Member
Author
|
Superseded by #215 — all commits from this branch are stacked there as part of a single QA-bundle PR. Closing without deleting the branch. |
Merged
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.
The lowercase 'r' is the canonical brand mark (matches the logo). Two website-side spots had drifted to `GoFR` / `Gofr` / naively title-cased renderings.
Changes
`src/lib/navigation.js`
Seven `desc:` strings used `GoFR` through-out the navigation metadata. This is the website's standalone copy; the framework's `gofr/docs/navigation.js` overlays it during the framework-docs docker build, so when paired with gofr#3398 the fix lands in both layers.
`src/components/Search.jsx`
`prettifySegment` was naive Title Case, so search breadcrumbs rendered slugs like `gofr-vs-gin` as "Gofr Vs Gin" and `wrap-grpc` as "Wrap Grpc".
Added a small `PRETTY_TOKENS` map covering the brand mark and common acronyms; plain words still fall through to Title Case:
So search breadcrumbs now read "Comparison › GoFr vs Gin" and "References › GoFr CLI" instead of the previous mangled forms.
Out of scope (intentionally)
Real Go identifiers and env-var conventions are left untouched:
Test
🤖 Generated with Claude Code