Skip to content

docs: add ArkEnv Release Candidate checklist - #1848

Merged
yamcodes merged 7 commits into
v1from
cursor/rc-checklist-c312
Sep 13, 2026
Merged

yamcodes merged 7 commits into
v1from
cursor/rc-checklist-c312

Conversation

@yamcodes

@yamcodes yamcodes commented Sep 12, 2026

Copy link
Copy Markdown
Owner

Summary

Adds an actionable maintainer Release Candidate checklist on v1 so Yam can check boxes against real files, open PRs, and Discussions before cutting 1.0.0-rc.n.

Documentation only - no channel flip, publish, or RELEASE_TAG change.

What changed

  • New docs/RC_CHECKLIST.md with verified “already done” items (milestone clear, no Typia in works-with, migration guide, CLI import guard, ROADMAP_EXTRAS done flags, alpha still active) plus sections A–F matching the RC plan
  • Cross-links from docs/LAUNCH_RUNBOOK.md (GA stays GA), docs/CONTRIBUTING.md, docs/README.md, and a pointer on ROADMAP_EXTRAS in apps/www/lib/roadmap/config.ts
  • Follow-up: docs AI-slop / voice pass tracked as Not-GA known gap (not an RC gate); ArkType ecosystem snippet called out as soft blocker for announce / day-of latest → rc only

Tip corrections baked in

Test plan

  • Relative paths in the checklist resolve to existing files (including URL-encoded (home) path)
  • Bidirectional LAUNCH_RUNBOOK ↔ RC_CHECKLIST links present
  • No em/en dashes in docs/RC_CHECKLIST.md
  • Maintainer review of Not-GA gaps / Discussions park decisions (execute at cut time)
Open in Web Open in Cursor 

Document an actionable RC maintainer checklist next to the GA launch
runbook, with cross-links from LAUNCH_RUNBOOK, CONTRIBUTING, docs index,
and ROADMAP_EXTRAS so alpha → rc work stays file-specific and does not
replace GA 1.0.0 steps.

Co-authored-by: Yam Borodetsky <hi@yam.codes>
@changeset-bot

changeset-bot Bot commented Sep 12, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 267e5bc

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@github-actions github-actions Bot added docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org labels Sep 12, 2026
cursoragent and others added 4 commits September 12, 2026 06:47
URL-encode parentheses in the homepage path link so markdown resolves,
and replace the Discussions number-range en dash with plain "through".

Co-authored-by: Yam Borodetsky <hi@yam.codes>
Track the docs AI-slop / voice rewrite as a Not-GA known gap (not an RC
gate), and call out the ArkType ecosystem import snippet as a soft
blocker only for announce / day-of latest → rc.

Co-authored-by: Yam Borodetsky <hi@yam.codes>
Replace the GFM \`> [!NOTE]\` alert with a plain blockquote so
\`pnpm run fix:mdx\` can parse the file, and accept mdxlint formatting
for the checklist.

Co-authored-by: Yam Borodetsky <hi@yam.codes>
@yamcodes
yamcodes marked this pull request as ready for review September 13, 2026 06:35

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ No critical issues — the checklist matches the current tip, but the hardcoded-alpha sweep misses two files.

Reviewed changes

  • Added docs/RC_CHECKLIST.md — maintainer checklist for the first 1.0.0-rc.n cut: an "already done" snapshot plus sections A–F (freeze, channel flip, publish/smoke, import guard, site cutover, Discussions) and an explicit "not RC gates" list.
  • Cross-linked the checklist from docs/LAUNCH_RUNBOOK.md (RC RELEASE_TAG line now defers to §B), docs/CONTRIBUTING.md, and docs/README.md.
  • Roadmap config noteapps/www/lib/roadmap/config.ts JSDoc now distinguishes RC sequencing from GA launch-day ops.

I verified the in-repo claims against the tip: ROADMAP_EXTRAS done flags, .changeset/pre.json (alpha), release.ts fallback, the package table names/versions, the referenced files, the runbook section numbers, and the current open PRs into v1. All hold. The cited milestone closed count has drifted (98 → 110) but is explicitly a dated snapshot with a re-verify instruction, so no action needed.

ℹ️ Nitpicks

  • docs/RC_CHECKLIST.md:318ROADMAP_EXTRA should be ROADMAP_EXTRAS, matching the exported constant referenced everywhere else in the file.

Pullfrog  | Fix all ➔Fix 👍s ➔View workflow run | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

Comment thread docs/RC_CHECKLIST.md
- lead still says packages ship as `1.0.0-alpha.x` under the
`alpha` npm tag; update for RC
- [ ] [`apps/www/content/docs/reference/agent-plugin.mdx`](../apps/www/content/docs/reference/agent-plugin.mdx)
- `@arkenv/agent-plugin@alpha` in MCP-only host copy / JSON

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The hardcoded-alpha sweep is missing two files that will still advertise the alpha tag after the RC flip. packages/agent-plugin/README.md is published on npm, so its MCP section is the most visible of the two.

Suggested change
- `@arkenv/agent-plugin@alpha` in MCP-only host copy / JSON
- `@arkenv/agent-plugin@alpha` in MCP-only host copy / JSON
- [ ] [`packages/agent-plugin/README.md`](../packages/agent-plugin/README.md)
- MCP server section still shows `npx -y @arkenv/agent-plugin@alpha`
- [ ] [`apps/www/content/docs/frameworks/tanstack-start.mdx`](../apps/www/content/docs/frameworks/tanstack-start.mdx)
- `:::info[Pinning alphas]` callout still says "pin exact `@arkenv/*` alpha versions"

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@yamcodes

Copy link
Copy Markdown
Owner Author

@pullfrog fixed, review

@pullfrog

pullfrog Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

No new review warranted: the only change since the prior review is the one-word typo fix ROADMAP_EXTRAROADMAP_EXTRAS in docs/RC_CHECKLIST.md:318, which is correct and complete. Note the earlier inline thread is still open — the hardcoded-alpha sweep does not list packages/agent-plugin/README.md (npx -y @arkenv/agent-plugin@alpha) or the :::info[Pinning alphas] callout in apps/www/content/docs/frameworks/tanstack-start.mdx; both still advertise alpha.

Pullfrog  | View workflow run | via Pullfrog | Using DeepSeek Flash (free via Pullfrog for OSS) | 𝕏

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@yamcodes
yamcodes merged commit 8e970d9 into v1 Sep 13, 2026
16 of 18 checks passed
@yamcodes
yamcodes deleted the cursor/rc-checklist-c312 branch September 13, 2026 13:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Adds or changes documentation, or acts as documentation in and of itself www Improvements or additions to arkenv.js.org

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants