Skip to content

docs: always capitalize Shorebird, Flutter, and Code Push#579

Merged
tomarra merged 3 commits into
mainfrom
docs/proper-noun-capitalization
Jul 2, 2026
Merged

docs: always capitalize Shorebird, Flutter, and Code Push#579
tomarra merged 3 commits into
mainfrom
docs/proper-noun-capitalization

Conversation

@tomarra

@tomarra tomarra commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Status

READY

Description

Per the marketing content guidelines (see #576), "Shorebird", "Flutter", and "Code Push" are proper nouns and should always be capitalized. This fixes 52 instances across 16 files where they appeared lowercase or partially-cased, in prose, headings, and frontmatter description fields.

Left untouched (15 occurrences) — these are Vale false positives, not brand-name prose mentions:

  • Domain names / email addresses: console.shorebird.dev, contact@shorebird.dev, download.flutter.dev
  • The shorebird.yaml config filename mentioned in prose
  • A GitHub issue shorthand: shorebirdtech/shorebird#3715
  • A file path placeholder: /path/to/flutter
  • Literal shell commands inside fenced code blocks (e.g. shorebird release android) — worth flagging to reviewers: Vale's built-in Vale.Terms rule (unlike our custom rules) does not reliably respect code-fence exclusion, so these had to be found and excluded by hand. Something to watch for if this check gets automated/blocking later.

Judgment calls worth a second look during review:

  • A few instances use "code push" as a generic industry term rather than Shorebird's specific feature name (e.g. "there are multiple other Code Push services publicly available", referring to competitors). I capitalized these per the literal guideline, but marketing may want "code push" lowercase when it's the generic technology category vs. Shorebird's own product.
  • "run Shorebird init" / "our Shorebird preview output" (in percentage-based-rollouts.mdx) — capitalizing the brand name reads slightly unusually right before a CLI subcommand name. Flagging in case marketing prefers a different phrasing here.

This is one of several small content PRs split out of #576 so the Vale.Terms check can eventually be made blocking without a giant, hard-to-review PR.

Test plan

tomarra added 2 commits July 2, 2026 11:47
Per the marketing content guidelines, these are proper nouns and
should always be capitalized. Fixes 52 instances across 16 files
where they appeared lowercase or partially-cased in prose, headings,
and frontmatter descriptions.

Left 15 occurrences untouched because they're not brand-name prose
mentions:
- Domain names and email addresses (console.shorebird.dev,
  contact@shorebird.dev, download.flutter.dev)
- The shorebird.yaml config filename
- A GitHub issue shorthand reference (shorebirdtech/shorebird#3715)
- A file path placeholder (/path/to/flutter)
- Literal shell commands inside fenced code blocks (shorebird release
  android, shorebird patch android --track=staging) — Vale.Terms
  doesn't respect code-fence exclusion the way custom scope:text
  rules do, so these were manually verified and excluded
@tomarra tomarra merged commit b18b381 into main Jul 2, 2026
3 checks passed
@tomarra tomarra deleted the docs/proper-noun-capitalization branch July 2, 2026 18:12
tomarra added a commit that referenced this pull request Jul 2, 2026
PR #581 (a typo fix based on pre-#579 content) and PR #579 (proper
noun capitalization) both touched this same line. Merge ordering
left the line with the pre-#579 casing and the pre-#581 typo, an
invisible regression since it wasn't part of either PR's diff by the
time both were merged. Restores both fixes.
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.

2 participants