Skip to content

release-notes: convert legacy HTMLBlock section to markdown#44

Merged
jduval23 merged 2 commits into
rokudev:v2.0from
chrisdp:convert-release-notes-from-htmlblock
May 18, 2026
Merged

release-notes: convert legacy HTMLBlock section to markdown#44
jduval23 merged 2 commits into
rokudev:v2.0from
chrisdp:convert-release-notes-from-htmlblock

Conversation

@chrisdp
Copy link
Copy Markdown
Contributor

@chrisdp chrisdp commented May 15, 2026

Summary

The Roku OS 7.5–2.4 section of release-notes/index.md was wrapped in a JSX <HTMLBlock> template literal. ReadMe doesn't process markdown inside HTMLBlock, so the ~104 [text](doc:slug) references in that section rendered literally instead of as links. This PR converts the block to plain markdown matching the upper-half style.

Changes

Commit 1 — release-notes/index.md: convert legacy HTMLBlock to markdown

  • Unwrapped the HTMLBlock at lines 1025–2102; converted the inner HTML to markdown.
  • Replaced dead Confluence artifacts with their v2 doc: equivalents where possible:
    • Playing-Videos_1608528.htmldoc:playing-videos
    • Debugging-SceneGraph-Applications_3736509.htmldoc:debugging
    • Fast-Video-Start_4262645.htmldoc:fast-video-start
    • Creating-Custom-Components_4260778.htmldoc:creating-custom-components
    • interface_1608549.htmldoc:interface
    • /pages/createpage.action?...title=roProgramGuidedoc:roprogramguide
    • /pages/createpage.action?...title=roTuner — no v2 doc, link removed
  • Linked the roDeviceInfo "Added Function" entries in OS 6.1 to their ifDeviceInfo anchors where the function still ships (7 of 9; GetCreationTime and GetPublisherId have no v2 doc).

Commit 2 — Repoint release-notes inbound links to new auto-generated slugs

Heading slugs change from Confluence form (roku-os-7-5) to ReadMe's auto-generated form (roku-os-75, matching the upper-half convention). 20 doc:release-notes#roku-os-X-Y inbound references across 13 files updated accordingly.

chrisdp added 2 commits May 15, 2026 15:16
The Roku OS 7.5–2.4 section was wrapped in a JSX <HTMLBlock> template
literal, which kept ReadMe's markdown processor from rendering the
[text](doc:slug) links inside (~104 unrendered links). Convert the block
to plain markdown matching the upper-half style.

Also clean up legacy Confluence artifacts in the converted section:
- Replace dead .html and /pages/createpage.action links with their v2
  doc: equivalents where they exist (drop where no v2 doc).
- Link the roDeviceInfo "Added Function" entries in OS 6.1 to their
  ifDeviceInfo anchors where the function still ships.

Heading slugs change from the old Confluence form (roku-os-7-5) to
ReadMe's auto-generated form (roku-os-75) — inbound links are
repointed in the next commit.
The legacy HTMLBlock section used Confluence-style heading IDs
(roku-os-7-5, roku-os-3-0, etc.). Converting those headings to plain
markdown lets ReadMe auto-generate the slug, which drops the dash
between digits (roku-os-75, roku-os-30) — matching the upper-half
section's convention.

Update the 20 doc:release-notes#roku-os-X-Y inbound references across
13 files to use the new slug form.
@jduval23 jduval23 merged commit cfc529c into rokudev:v2.0 May 18, 2026
1 check failed
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