Skip to content

docs: quick-wins typos, _order.yaml fixes, empty link removal#52

Merged
jduval23 merged 1 commit into
rokudev:v2.0from
bblietz:fix/quick-wins-typos-order-yaml
May 20, 2026
Merged

docs: quick-wins typos, _order.yaml fixes, empty link removal#52
jduval23 merged 1 commit into
rokudev:v2.0from
bblietz:fix/quick-wins-typos-order-yaml

Conversation

@bblietz
Copy link
Copy Markdown

@bblietz bblietz commented May 19, 2026

Summary

Audit-driven cleanup (May 16 audit, fix-now items, Scope A). Mechanical fixes only; no link rewrites or scope expansion.

  • Typos: 17 line edits across 13 files (8 audit-listed misspellings + 4 additional occurrences found during sweep -- same misspellings, other files)
  • _order.yaml nav fixes: 3 entries (2 underscore-vs-hyphen mismatches in DEVELOPER/roku-pay/, 1 orphan recs entry in THE ROKU CHANNEL/video-on-demand/)
  • Empty-link removal: 1 (DEVELOPER/dev-tools/sgdex.md L17 -- duplicate of working link on L15)

Lint baseline preserved: docs-lint shows the same 3 findings as before this PR (all in REFERENCES/brightscript/interfaces/ifscreen.md, unchanged).

File-by-file

Typos

File Line Was Now
DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md 2 Resouce (nav title) Resource
same 43 Requried (HTML table cell) Required
DEVELOPER/discovery/continue-watching-cloud.md 14 Canda Canada
DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md 15 in order to published in order to publish
DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md 15 in order to published in order to publish
DEVELOPER/getting-started/first-steps.md 29 being running begin running
DEVELOPER/core-concepts/index.md 28 Roku app app development Roku app development
DEVELOPER/roku-pay/quickstart/product-catalog.md 499 betan app beta app
REFERENCES/brightscript/interfaces/ifaudioresource.md 19 roAudioResouce (prose) roAudioResource
REFERENCES/brightscript/components/roaudioresource.md 15 roAudioResouce (prose) roAudioResource
VIDEOS/demos/index.md 27 explained reviewed reviewed (dropped extra word)
same 29 Resoure Monitor Resource Monitor
same 31 Resoure Monitor Resource Monitor
same 51 betan app feature beta app feature
VIDEOS/demos/summit-2021.md 15 betan app feature beta app feature
THE ROKU CHANNEL/video-on-demand/index.md 66 Not that partners Note that partners
THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md 713 Roku Direct Published feed specification Roku Direct Publisher feed specification

_order.yaml

File Change
DEVELOPER/roku-pay/_order.yaml signup_best-practices -> signup-best-practices (target file is signup-best-practices.md)
same signin_best-practices -> signin-best-practices (target file is signin-best-practices.md)
THE ROKU CHANNEL/video-on-demand/_order.yaml remove recs (no backing file in directory)

Empty link

File Change
DEVELOPER/dev-tools/sgdex.md L17 delete empty-target markdown link; duplicates working link on L15

Out of scope (deferred to follow-up PR -- requires URL convention decision)

  • ovp-linear-ingest-spec.md L15 / L396 / L707: broken /trc-docs/... links pointing at legacy paths. L396 + L707 use full developer.roku.com URLs with locale prefixes (and L707 has en-ot -- not a valid locale).
  • ovp-linear-ingest-spec.md L713: 3 broken /docs/specs/direct-publisher-feed-specs/json-dp-spec.md links. Target file does not exist anywhere in the repo. Needs a content decision (replace with external URL, delete the link, or restore the missing spec doc).

Test plan

  • node .github/scripts/docs-lint/index.mjs shows same 3 baseline findings (all in ifscreen.md, untouched)
  • Verified 0 hits for every targeted typo pattern after the sweep
  • _order.yaml entries now match actual filenames (verified by ls docs/DEVELOPER/roku-pay/)
  • CI run on this PR

Related

Part of the May 16 audit cleanup plan (dev-doc-review-report-2026-05-16.md § 16 step 1). Next sweep PRs in the queue: BrightScript fence labeling (~1,300 fences), terminology canonicalization (~25 hits), broken-absolute-link sweep (252 remaining).

Audit-driven cleanup (May 16 audit, fix-now items, Scope A). Mechanical
fixes only; no link rewrites or scope expansion.

Typos (17 line edits across 13 files):
- DEVELOPER/dev-tools/resource-monitor/rrm-data-collection-mode.md
  L2 "Resouce" -> "Resource" (nav title)
  L43 "Requried" -> "Required" (HTML table cell)
- DEVELOPER/discovery/continue-watching-cloud.md
  L14 "Canda" -> "Canada"
- DEVELOPER/certification-overview/cert-tests/static-analysis-tool-1.md
  L15 "in order to published" -> "in order to publish"
- DEVELOPER/certification-overview/cert-tests/channel-behavior-analysis-tool.md
  L15 "in order to published" -> "in order to publish"
- DEVELOPER/getting-started/first-steps.md
  L29 "being running" -> "begin running"
- DEVELOPER/core-concepts/index.md
  L28 "Roku app app development" -> "Roku app development"
- DEVELOPER/roku-pay/quickstart/product-catalog.md
  L499 "betan app" -> "beta app" (found during sweep, not in audit)
- REFERENCES/brightscript/interfaces/ifaudioresource.md
  L19 "roAudioResouce" -> "roAudioResource" (prose; found during sweep)
- REFERENCES/brightscript/components/roaudioresource.md
  L15 "roAudioResouce" -> "roAudioResource" (prose; found during sweep)
- VIDEOS/demos/index.md
  L27 "explained reviewed" -> "reviewed"
  L29 "Resoure Monitor" -> "Resource Monitor"
  L31 "Resoure Monitor" -> "Resource Monitor"
  L51 "betan app feature" -> "beta app feature"
- VIDEOS/demos/summit-2021.md
  L15 "betan app feature" -> "beta app feature" (duplicate boilerplate; found during sweep)
- THE ROKU CHANNEL/video-on-demand/index.md
  L66 "Not that partners" -> "Note that partners"
- THE ROKU CHANNEL/live-linear/ovp-linear-ingest-spec.md
  L713 "Roku Direct Published feed specification" -> "Roku Direct Publisher feed specification"

_order.yaml nav fixes:
- DEVELOPER/roku-pay/_order.yaml
  signup_best-practices -> signup-best-practices (file is signup-best-practices.md)
  signin_best-practices -> signin-best-practices (file is signin-best-practices.md)
- THE ROKU CHANNEL/video-on-demand/_order.yaml
  remove 'recs' (no backing file in directory)

Empty-link cleanup:
- DEVELOPER/dev-tools/sgdex.md
  L17 delete empty-target link (duplicates working link on L15)

Out of scope (deferred to follow-up PR, requires URL convention decision):
- ovp-linear-ingest-spec.md L15/L396/L707 broken /trc-docs/ links
- ovp-linear-ingest-spec.md L713 broken json-dp-spec.md links (target does not exist anywhere in repo)

Lint baseline preserved: docs-lint shows same 3 findings as before this
PR (all in REFERENCES/brightscript/interfaces/ifscreen.md, unchanged).
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