Skip to content

docs: fix typos, grammar, and terminology consistency (copyedit pass) - #85

Open
bblietz wants to merge 3 commits into
v2.0from
docs-cleanup-tier2-3
Open

docs: fix typos, grammar, and terminology consistency (copyedit pass)#85
bblietz wants to merge 3 commits into
v2.0from
docs-cleanup-tier2-3

Conversation

@bblietz

@bblietz bblietz commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Summary

Mechanical copyedit pass across the docs: fixes typos, doubled words, grammar defects, and product-term casing/spelling inconsistencies surfaced by an automated + manual audit. 77 files, 126 word-level substitutions, no structural changes. Every change was individually verified against source; nothing inside code fences, API field names, enum values, or asset paths was altered.

Tier 3 - typos & grammar

  • Misspellings: photograpy→photography, quartely→quarterly, intall→install, mechansim→mechanism, contactually→contractually, subscritpion→subscription, cancelation→cancellation, availabilty→availability, occuring→occurring, responsiiblwe→responsible, encounted→encountered, paramaters→parameters, requried→required
  • Doubled words removed: "is is", "the the", "node node", "be be", "that that", "will will", "to to", "and and", "of of", "or or", "this this"
  • Wrong/missing words: affect vs effect, "Building apps requires", "returns an Associative array", "authority to submit", "fewer than 1,000", "Not all devices support...", "live linear", present-tense "identifies", "valid WAV file", "Specifies how"

Tier 2 - terminology consistency

  • BrightscriptBrightScript (36 prose/label instances; confirmed against the corpus-majority BrightScript Debugger> prompt casing)
  • RokuOSRoku OS (prose only; preserved the /RokuOS/Artwork/ firmware asset path)
  • WiFi / WifiWi-Fi (prose only; preserved lowercase wifi feature-check value and the <wifi-mac> ECP tag)
  • Scene Graph / ScenegraphSceneGraph
  • Prose US spelling: labelled→labeled, prose cancelled→canceled, grey→gray

Deliberately preserved (real API surface, not errors)

  • Nabu Cloud organisation entity name
  • Roku Pay cancelled JSON/XML field name
  • BBFC behaviour ratings enum value

Out of scope

deep link / deep-link / deeplink variants were left alone: the hyphenated compound-adjective form vs the open noun form are both correct, so this needs a per-instance style decision rather than a sweep. A separate set of factual contradictions (e.g. HEVC bitrate 40 vs 25 Mbps, Verimatrix DRM listed then declared removed, mediaType vs feed-type casing) was also found and needs SME sign-off on the correct values; not included here.

Test plan

  • Rendered spot-check of changed pages (SceneGraph reference, Roku Pay, analytics reports, media specs)
  • Confirm no code samples, field names, or asset paths were altered

bblietz added 3 commits August 19, 2026 14:48
- Correct misspellings (photography, quarterly, install, mechanism,
  contractually, subscription, cancellation, availability, occurring,
  responsible, encountered, parameters, required)
- Remove doubled words (is is, the the, node node, be be, that that,
  will will, to to, and and, of of, or or, this this)
- Fix wrong/missing words (affect vs effect, requires, an Associative
  array, authority to submit, fewer than, Not all devices, live linear,
  identifies, occur, valid WAV file, Specifies how)
- Brightscript -> BrightScript (36 prose/label/output instances)
- RokuOS -> Roku OS (preserving the /RokuOS/ firmware asset path)
- WiFi/Wifi -> Wi-Fi (preserving lowercase 'wifi' API feature value
  and <wifi-mac> ECP tag)
- Scenegraph / 'Scene Graph' -> SceneGraph
- labelled -> labeled (SceneGraph divider descriptions)
- cancelled -> canceled (analytics report glossaries, prose only)
- grey -> gray (Scene default-palette description)

Deliberately preserved as real API values: Nabu Cloud 'organisation'
entity, Roku Pay 'cancelled' field name, and the BBFC 'behaviour'
ratings enum value.
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