Repository navigation
docs: release notes for the network, radius-sdk, radius-cli and the Radius skills, with a feed - #92
Merged
Merged
Conversation
…r version (ENG-2633) plugins/radius/CHANGELOG.md backfills 0.0.2 to 0.2.2 from the versions as they landed on main, written for developers who use the skills. The docs release notes will be built from it. validate_plugin.py fails when the manifest version has no `## <version> (<YYYY-MM-DD>)` entry, when headings are malformed, or when versions or dates are not newest first. The changelog is not release content (skills, manifest, README), so it needs no plugin version bump. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012M6NrUBhuq32wQaTAVbWn7
… skills changelogs (ENG-2633) scripts/generate-release-notes.ts writes docs/pages/release-notes.mdx and an Atom feed, public/release-notes.xml (both gitignored), newest first, from: - release-notes/network.md: the Radius Network notes, moved from the page - packages/sdk and packages/cli CHANGELOG.md (Changesets): a version is listed once its <package>@<version> tag exists, dated by the tag, with npm and GitHub release links; Major/Minor/Patch become Breaking changes, New and Fixes, and "Updated dependencies" becomes one "Uses ..." line - plugins/radius/CHANGELOG.md: the Radius skills Each release is a `## <date>: <product> <version>` heading, so its anchor is a stable link to share. Each change's first sentence is bolded as its headline, as written. The page description names the latest release, so link previews and llms.txt show what is new. The generator fails when a checkout has no release tags; docs CI now fetches history and tags like docs-deploy, runs the generator tests, and runs on CLI changelog changes. prebuild, predev, docs:validate and docs:markdown-audit run the generator. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012M6NrUBhuq32wQaTAVbWn7
- Every page links the Atom feed (<link rel="alternate">) for feed readers and agents; _headers serves it as application/atom+xml. - The Worker records feed fetches with the other agent files, so docs_agent_fetches shows who follows release notes. - A link to a heading scrolls it below both fixed bars. Vocs offsets headings for the top nav only, so the "On this page" bar covered a shared release on phones and desktops. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012M6NrUBhuq32wQaTAVbWn7
Contributor
erikzrekz
marked this pull request as ready for review
October 27, 2026 13:10
azf20
previously approved these changes
Oct 27, 2026
…nges (ENG-2633) radius-sdk 0.7.0 marks its peer-dependency move "**Breaking for installs:**", which the "**Breaking:**"-only rule left under New. Any bold text starting with "Breaking" now counts. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_012M6NrUBhuq32wQaTAVbWn7
Contributor
|
kylecrawshaw
approved these changes
Oct 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Part of ENG-2633 (project: Docs analytics-driven improvements). Builds on #91, now merged.
Why
Release notes are the #2 page on docs.radiustech.xyz (80 views, Sep 26 – Oct 26), but they cover the network only, and the newest entry is 2026-09-28. Since then:
None of that reached the page. Most traffic arrives as pasted links (61% direct), and 43% of it is on phones, so each release needs its own link that works there.
What changes
Skills changelog (
1ef942d)plugins/radius/CHANGELOG.md, backfilled from 0.0.2 to 0.2.2 using the versions as they landed onmain. I checked each entry against its diff.scripts/validate_plugin.pyfails CI when the manifest version has no## <version> (<YYYY-MM-DD>)entry, a heading is malformed, or entries aren't newest first.Generated page and feed (
022e955,e8b54d6)scripts/generate-release-notes.tswritesdocs/pages/release-notes.mdxandpublic/release-notes.xml. Both are gitignored.prebuild,predev,docs:validateanddocs:markdown-auditrun it.release-notes/network.mdCHANGELOG.md(Changesets)<pkg>@<version>tag exists, dated by the tag, so the docs never announce what isn't on npm. Major / Minor / Patch become Breaking changes / New / Fixes. A minor change with bold text starting "Breaking" (**Breaking:**,**Breaking for installs:**) goes under Breaking. "Updated dependencies" becomes oneUses radius-sdk@x.y.z.line. Links to npm and the GitHub release.plugins/radius/CHANGELOG.md## <date>: <product> <version>heading, so#2026-10-27-radius-sdk-070is a stable link to share. A table at the top links the latest release of each product.llms.txtshow what's new.docs.ymlnow checks out withfetch-depth: 0andfetch-tags: true, likedocs-deploy.yml.docs.ymlruns the new tests (pnpm test:release-notes) and also triggers onpackages/cli/CHANGELOG.md.Sharing and measurement (
16c67fc)<link rel="alternate" type="application/atom+xml">on every page._headersserves the feed asapplication/atom+xml.docs_agent_fetches.Up to date with
main(aee3b3d)main, which brings in docs: record agent fetches of pages and agent files, serve Markdown on request (Workers Logs + Analytics Engine) #91, Let the Version Packages PR run CI; install x402 peers in skills #89 and the Version Packages release (radius-sdk 0.7.0 and radius-cli 0.6.0, tagged 2026-10-27). No conflicts.e8b54d6.Why not Vocs's built-in
::changelog: it reads GitHub Releases from one repo and renders through a client component. It has no per-product anchors, network notes, skills or feed.Verification
On
e8b54d6:packages/docs, all pass:format:check,lint,typecheck:docs,docs:validate(0 errors, 0 warnings, including the generated page),test:skills,test:release-notes(10 tests),docs:markdown-audit,build,docs:agent-checkanddocs:sitemap-check.python3 scripts/validate_plugin.py --base-ref origin/mainpasses. With a malformed heading, or the current version removed from the changelog, it fails as intended (checked on1ef942d).On
16c67fc:llms.txtand sitemap:/release-notes.md, thellms.txtline and the sitemap entry are present.wrangler dev+ Playwright, 390 px and 1280 px: no horizontal overflow, and an anchor link lands below both fixed bars on phone, desktop and 1600 px. It did not before the CSS fix.application/atom+xmland are recorded asagent fetch.noindexstill applies onworkers.devhosts.For the reviewer
mainwithout this PR, so the live page shows the new entries only after the next deploy.🤖 Generated with Claude Code
https://claude.ai/code/session_012M6NrUBhuq32wQaTAVbWn7