Skip to content

docs: add proof-first launch checklist#487

Merged
mohanagy merged 1 commit into
nextfrom
issue-474-distribution-launch-checklist
Jun 3, 2026
Merged

docs: add proof-first launch checklist#487
mohanagy merged 1 commit into
nextfrom
issue-474-distribution-launch-checklist

Conversation

@mohanagy
Copy link
Copy Markdown
Owner

@mohanagy mohanagy commented Jun 3, 2026

Summary

Test Plan

  • npm run typecheck
  • npm run build
  • CI=1 npm run test:run

Refs #474

Summary by CodeRabbit

  • Documentation

    • Added launch checklist template for preparing public releases with proof-first requirements and channel tracking guidance
    • Updated release documentation to incorporate launch checklist steps
    • Updated roadmap to reflect v0.30 adoption and contributor experience improvements
  • Tests

    • Added verification tests for launch checklist documentation

Refs #474

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 3, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: b16c10ac-50dc-482a-98b7-83fc88ca37fb

📥 Commits

Reviewing files that changed from the base of the PR and between 0c734b5 and 8ce1cc6.

📒 Files selected for processing (6)
  • README.md
  • docs/launch-checklist.md
  • docs/release.md
  • docs/roadmap.md
  • tests/unit/launch-checklist-doc.test.ts
  • tests/unit/roadmap-docs.test.ts

📝 Walkthrough

Walkthrough

This PR introduces a reusable launch checklist template (docs/launch-checklist.md) for proof-first releases and adoption announcements, integrates it into the user-facing documentation and release process across README, release checklist, and roadmap, and adds validation tests to ensure the template structure and cross-references are maintained.

Changes

Launch Checklist Feature

Layer / File(s) Summary
Launch checklist template
docs/launch-checklist.md
Defines a proof block structure, channel-by-channel tracker table for update/proof/caveat status, guidance for drafting benchmark-backed launch posts (with issue #469 reference and bundle paths), and messaging guardrails.
User-facing documentation and roadmap updates
README.md, docs/roadmap.md, docs/release.md
README adds launch checklist links to install details and "What's New" sections; roadmap documents issue #474 for proof-first release checklist; release.md integrates checklist requirements into pre-release, pre-posting, and post-release steps.
Documentation structure and cross-reference validation
tests/unit/launch-checklist-doc.test.ts, tests/unit/roadmap-docs.test.ts
New and updated tests verify launch checklist structure (proof block, channel tracker, benchmark draft details), confirm the checklist is linked from README and release.md, and assert roadmap includes issue #474 and launch checklist reference.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related issues

Possibly related PRs

  • mohanagy/madar#485: Both PRs update docs/roadmap.md and tests/unit/roadmap-docs.test.ts to add new issue-based roadmap item assertions.
  • mohanagy/madar#459: Both PRs modify the same roadmap documentation and test surfaces by adding new roadmap assertions.

Poem

🐰 A checklist is born, all proof-first and true,
With benchmarks and channels to guide what's new,
From README to release, the threads now align—
A hop toward launches that sparkle and shine! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: add proof-first launch checklist' clearly and concisely summarizes the main change: adding a new documentation template for proof-first launch workflows.
Description check ✅ Passed The description covers the key changes (new template, linking from docs, regression tests) and includes a comprehensive test plan with all three verification steps checked, but the Testing section formatting does not exactly match the template structure.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue-474-distribution-launch-checklist

Comment @coderabbitai help to get the list of available commands and usage tips.

@mohanagy mohanagy merged commit 8fade42 into next Jun 3, 2026
7 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Jun 3, 2026
9 tasks
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