Skip to content

docs: add publication dry run checklist #158

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
saagpatel merged 1 commit into from
Jun 7, 2026
Merged

docs: add publication dry run checklist #158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/demo/portfolio-handoff-bundle.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,25 @@ repo evidence or labeled as illustrative.

## Pre-Publish Checklist

Publication dry run, in reader order:

1. Open the root [README](../../README.md) and confirm the public demo section
points to the sanitized demo plan, portfolio index, and this handoff.
2. Open the [sanitized demo plan](./sanitized-demo-plan.md) and confirm the
fake-KB script uses the Jordan/Northstar USB/offsite story.
3. Open the [portfolio index](../portfolio/README.md) and confirm the four
primary artifacts link to committed files or explicit rebuild instructions.
4. Open the committed artifacts:
[one-pager PDF](../one-pager/AssistSupport-one-pager.pdf),
[deck PDF preview](../deck/AssistSupport-LinkedIn-Live.pdf), and
[screenshot contact sheet](../screenshots/renders/contact-sheet.png).
5. Open the [case study](../case-study.md), [rehearsal kit](../deck/REHEARSAL.md),
and [demo video script](../deck/DEMO-VIDEO.md). Confirm they use the same
Jordan/Northstar story and the current fictional gap labels.
6. Treat `docs/deck/AssistSupport-LinkedIn-Live.pptx` as a local editable
rebuild output only. Share the committed PDF preview unless rebuilding the
deck for a live presentation.

Before posting the portfolio set, run:

```bash
Expand Down
5 changes: 3 additions & 2 deletions docs/demo/sanitized-demo-plan.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ Unsafe sources:
data and offers approved alternatives: SharePoint, OneDrive, ShareFile,
encrypted email for small files, or VPN-connected file shares.
5. Hover a citation and show that it maps to the checked-in policy KB.
6. Rate the draft, then open Analytics to show fictional gap clusters such as
`VPN fails only on HQ Wi-Fi` and `Outlook crash on macOS 14.5`.
6. Rate the draft, then open Analytics to show fictional gap clusters:
`VPN won't connect at HQ but works on hotspot` and
`Outlook keeps crashing on macOS 14.5`.
7. Call out the privacy posture: local mock IPC, no real tenant data, no cloud AI
call, encrypted core workspace in real use.

Expand Down
2 changes: 1 addition & 1 deletion docs/portfolio/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ Engineering-professional across all artifacts:
pnpm install
pnpm ui:typecheck
pnpm lint
pnpm test # 266 tests including WorkspaceHeroLayout.test.tsx
pnpm test # includes WorkspaceHeroLayout.test.tsx

# Session 2 — live captures (real app) or HTML mockups
node docs/screenshots/live-capture.mjs # panels 01/02/04/05 from running dev server
Expand Down
Loading