Skip to content

docs(runtimes): runtime changelog + periodic update tooling#800

Draft
HayesGordon wants to merge 3 commits into
mainfrom
runtime-changelog
Draft

docs(runtimes): runtime changelog + periodic update tooling#800
HayesGordon wants to merge 3 commits into
mainfrom
runtime-changelog

Conversation

@HayesGordon

@HayesGordon HayesGordon commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Adds a runtime changelog at /runtimes/changelog and the tooling to produce it periodically - covering all 8 Rive runtimes (Apple, Android, Web, React, React Native, Flutter, Unity, Unreal) plus a derived Core runtime section for shared C++ changes. As a bonus, it keeps the docs' install-version snippets from going stale.

How it works

The design splits deterministic facts from one AI editorial step:

Piece Role AI?
scripts/runtime-changelog/collect.mjs Reads package registries + GitHub, decides what shipped, owns every version/date/URL No
.claude/skills/runtime-announcement Turns collected notes into changelog prose; reviewed every run Yes (prose only)
scripts/runtime-changelog/digest.mjs Reassembles the committed changelog into a copy-paste community post No
scripts/runtime-changelog/state.json Committed record of last-announced version per runtime - the boundary for the next entry No

Versions, dates, and links are never AI-authored - the agent only writes wording. --advance-state also syncs docs.json version variables (versionApple, versionWeb, …) to each runtime's latest, so wired install snippets never rot.

Usage

One command in Claude Code: /runtime-announcement. It collects releases → drafts the entry → shows you the entry + a preview of the community post → you approve → it records state and bumps docs versions → you review git diff and commit. The community post is saved to generated/community-post.md (git-ignored) for pasting into Discord/forum. Full runbook in scripts/runtime-changelog/README.md.

What's in this PR

  • Changelog page + baseline entry covering all 8 runtimes
  • Tooling: collect.mjs, digest.mjs, state.json, README.md, the skill
  • docs.json: nav entry + auto-synced runtime version variables
  • 8 runtime docs pages: install snippets wired to those variables, replacing stale hardcoded versions (e.g. iOS 6.13.0→current, RN default block 6.12.0→current)

Everything is local and human-reviewed - no commits, pushes, or PRs happen automatically.

Still on the table

  • Pick a changelog shape. Two pages are included for comparison: changelog.mdx (grouped by date) and changelog-per-runtime.mdx (grouped by runtime, filterable). Delete the loser + its temp docs.json nav entry before merge.
  • CLAUDE.md still says mintlify - the CLI is now mint. Separate cleanup.
  • No automation yet - scheduled runs / auto-PRs are intentionally out of scope; revisit once the manual flow is proven.
  • Core links the repo, not a version - rive-runtime has no releases yet. When it does, Core can link a specific version.
  • RN default-version block tracks "latest" - accurate today (RN bundles latest), with prose pointing at package.json if it ever lags.

@HayesGordon
HayesGordon requested a review from a team as a code owner July 17, 2026 17:30
@HayesGordon
HayesGordon marked this pull request as draft July 17, 2026 17:30
@mintlify

mintlify Bot commented Jul 17, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
rive 🟢 Ready View Preview Jul 17, 2026, 5:33 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

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.

1 participant