Skip to content

docs: fix GoFr brand casing in headings and nav descriptions#3398

Open
aryanmehrotra wants to merge 2 commits into
developmentfrom
docs/fix-gofr-casing
Open

docs: fix GoFr brand casing in headings and nav descriptions#3398
aryanmehrotra wants to merge 2 commits into
developmentfrom
docs/fix-gofr-casing

Conversation

@aryanmehrotra

@aryanmehrotra aryanmehrotra commented May 5, 2026

Copy link
Copy Markdown
Member

Summary

The lowercase 'r' is the canonical brand mark (matches the logo). Several pages had drifted to 'GoFR' (all-caps R) or 'Gofr' (lowercase 'ofr'):

  • `docs/references/gofrcli/page.md` — H1 was 'GoFR Command Line Interface' (visible on /docs/references/cli)
  • `docs/navigation.js` — 7 `desc:` strings used 'GoFR'
  • `docs/advanced-guide/grpc/page.md` — H1 'gRPC with Gofr' + an H2 'Registering the gRPC Service with Gofr'
  • `docs/advanced-guide/overriding-default/page.md` — a sample list-item string ('Expand on Gofr documentation')

The lowercase 'r' is the canonical brand mark (matches the logo).
Several places had drifted to 'GoFR' (all-caps R) or 'Gofr'
(lowercase 'ofr'):

  - docs/references/gofrcli/page.md → 'GoFR Command Line Interface'
  - docs/navigation.js — 7 description strings
  - docs/advanced-guide/grpc/page.md — H1 + H2
  - docs/advanced-guide/overriding-default/page.md — sample-string
    inside an example struct

Code identifiers left alone — `RegisterServerWithGofr` (real Go
function name in pkg/), `GOFR_TELEMETRY` (env-var convention).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 5, 2026 18:23

Copilot AI 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.

Pull request overview

This PR standardizes user-facing documentation to the canonical GoFr brand casing. It is a docs-only cleanup that aligns headings and navigation copy with the rest of the documentation set while leaving intentional code identifiers unchanged.

Changes:

  • Updated the CLI reference page H1 from GoFR to GoFr.
  • Corrected several navigation description strings to use GoFr.
  • Fixed Gofr casing in gRPC and overriding-default documentation prose/examples.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
docs/references/gofrcli/page.md Fixes the CLI reference page heading to the canonical GoFr casing.
docs/navigation.js Normalizes multiple navigation description strings to GoFr.
docs/advanced-guide/overriding-default/page.md Updates a sample TODO string in the docs example to GoFr.
docs/advanced-guide/grpc/page.md Corrects gRPC page headings to use GoFr in prose.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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.

3 participants