Skip to content

docs: add publication dry run checklist#158

Merged
saagpatel merged 1 commit into
masterfrom
codex/docs/publication-dry-run-checklist
Jun 7, 2026
Merged

docs: add publication dry run checklist#158
saagpatel merged 1 commit into
masterfrom
codex/docs/publication-dry-run-checklist

Conversation

@saagpatel

Copy link
Copy Markdown
Owner

What

  • Added a publication dry-run checklist to the portfolio handoff bundle in reader order.
  • Aligned the sanitized demo plan's Analytics gap labels to the current Jordan/Northstar mock data.
  • Removed a stale fixed test-count comment from the portfolio regeneration commands.

Why

The portfolio collateral is now sendable, but the handoff needed one final reader-path pass so a publisher can open the root README, follow the demo and artifact links, and know which files are committed share artifacts versus local rebuild outputs.

How

  • Captured the exact public reader path from root README through demo plan, portfolio index, committed PDFs, screenshot sheet, case study, rehearsal kit, and demo video script.
  • Kept the deck PPTX framed as local editable rebuild output and the PDF as the committed share artifact.
  • Normalized the fake gap-cluster labels to match the current mock IPC seed data.

Testing

  • pnpm exec prettier --check README.md docs/demo/sanitized-demo-plan.md docs/demo/portfolio-handoff-bundle.md docs/portfolio/README.md docs/case-study.md docs/deck/README.md docs/deck/REHEARSAL.md docs/deck/DEMO-VIDEO.md docs/one-pager/README.md docs/screenshots/README.md docs/screenshots/CAPTIONS.md
  • Local markdown link existence check across the reader-path docs.
  • Stale text scan for fixed test counts, old gap labels, stale deck-preview notes, and public PPTX links.
  • Sanitized boundary scans for private/company placeholders and stale device-policy examples.
  • pdfinfo sanity checks for one-pager and deck PDFs.
  • sips dimension checks for contact sheet, one-pager PNG, and workspace screenshot.
  • node scripts/ci/check-workstation-preflight.mjs
  • node scripts/ci/check-workflow-command-drift.mjs
  • node scripts/ci/check-version-parity.mjs
  • git diff --check
  • Git branch, atomic, generated, large-file, and secrets guards.

Risks

Low. Documentation-only change. The main risk is wording drift in future artifact refreshes; the new dry-run checklist is meant to reduce that.

Performance impact

None expected. Documentation-only change; no runtime, bundle, API, database, or UI behavior changed.

Lockfile rationale

No lockfiles changed.

Screenshots

Not applicable. Documentation-only change; no UI surface changed. The committed contact sheet was visually reviewed during the dry run.

@saagpatel saagpatel merged commit ebad928 into master Jun 7, 2026
33 checks passed
@saagpatel saagpatel deleted the codex/docs/publication-dry-run-checklist branch June 7, 2026 14:40
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