Skip to content

docs: reorg — dev-setup guide + concise staging plan + archive cleanup#53

Merged
hanwencheng merged 1 commit intomainfrom
docs/reorg-dev-onboarding
Apr 23, 2026
Merged

docs: reorg — dev-setup guide + concise staging plan + archive cleanup#53
hanwencheng merged 1 commit intomainfrom
docs/reorg-dev-onboarding

Conversation

@hanwencheng
Copy link
Copy Markdown
Member

Summary

Follow-up to #52. No runtime code changes — docs + .gitignore only.

  • docs/spec/plans/development-stages.md — rewritten from 1623 lines of full per-stage history into ~180 lines organized as Shipped / Active / Planned. Full v1 preserved at docs/archived/development-stages-v1-2026-04.md.
  • docs/dev-setup.md — new single-source dev onboarding + demo guide. CDP-only (OpenRouter + OpenAI); the Gmail-backed demo variant is explicitly dismissed and archived.
  • docs/archived/ (13 files moved + README.md) — supersession mapping + archive policy. Covers the old development-stages, the manual-test-stage{4,5,6}.md files, stage5-workspace-email-setup.md, and the eight per-issue manual-test files from the Stage 4 campaign.
  • .gitignore — blocks Stage 6 one-shot JSON artifacts from creeping back in (bucket-policy*.json, daemon-user-inline.json, dns-change.json, probe*.mjs) per CLAUDE.md's "use jq -n --arg piped straight into the CLI, never heredoc JSON" rule; plus the double-nested provisioner-scripts/provisioner-scripts/ tsx-cwd artifact.
  • CLAUDE.md — keeps the one-line "do not read folder docs/archived" hint so future sessions skip the archive by default.

Rationale

  • Single staging plan doc was drifting. 1623 lines across Stage 0→9 accumulated over three months; agents + reviewers kept re-reading completed-stage contracts. Splitting into Shipped / Active / Planned makes it a current-state roadmap instead of a history book.
  • Multiple demo paths were confusing. Gmail+plus-addressing, Workspace+OAuth, SES+S3 — each had its own manual-test doc. We've standardized on CDP+SES for both OpenRouter and OpenAI; the other paths are archived.
  • Root-level bucket-policy.json/daemon-user-inline.json/dns-change.json kept re-appearing because operators followed old heredoc patterns. One of them even had the zsh modifier bug baked in (429071895007ole — missing :r expansion). .gitignore now refuses to let them back.

Test plan

  • cargo build --workspace --release — unchanged (no code touched)
  • cargo test --workspace — unchanged (no code touched)
  • All links in new docs/dev-setup.md resolve to existing files in-repo
  • All links in new docs/spec/plans/development-stages.md resolve
  • grep -r gmail docs/dev-setup.md docs/spec/plans/development-stages.md returns only the "archived Gmail-backed variants" pointer in the intro
  • docs/archived/README.md covers every moved file

Out of scope

  • Stage 5b implementation — plan preserved at ~/.claude/plans/an-agentkey-user-could-streamed-meteor.md, lands in a separate PR once telemetry substrate is ready.
  • Stage 6 finalization (TEE-BYODKIM, auto-AssumeRole) — blocked on heima-gaps §3.

🤖 Generated with Claude Code

Replaces the 1623-line stage-by-stage history with a Shipped / Active /
Planned summary; adds a single CDP-only dev-setup + demo guide;
archives the drifted manual-test-*.md per-issue files and the
Gmail-backed demo variants.

- `docs/spec/plans/development-stages.md` — rewritten (~180 lines).
  Shipped: Stages 0-5a + 6 (interim) each as one-line summaries.
  Active: Stage 5b telemetry + LLM-fallback plan, Stage 6 finalization.
  Planned: Stage 7 OIDC, Stage 8 Priority A, npm packaging.
- `docs/dev-setup.md` — CDP-only onboarding guide. Prereqs → build →
  Stage 6 env → OpenRouter demo → OpenAI demo → verify → troubleshoot.
  Explicitly dismisses the Gmail demo variant (archived).
- `docs/archived/` — 13 files moved (development-stages v1, four
  manual-test-stage{4,5,6} / stage5-workspace-email-setup, and the
  eight per-issue manual-test-issue-1X.md + report). README.md spells
  out the supersession mapping + archive policy.
- `.gitignore` — block Stage 6 one-shot JSON artifacts from creeping
  back (`bucket-policy*.json`, `daemon-user-inline.json`,
  `dns-change.json`, `probe*.mjs`) per CLAUDE.md's jq-only rule; ignore
  the double-nested `provisioner-scripts/provisioner-scripts/` tsx
  cwd artifact.
- `CLAUDE.md` — keep the "do not read folder docs/archived" hint.

Follow-up to #52. No runtime code changes; docs + gitignore only.
@hanwencheng hanwencheng force-pushed the docs/reorg-dev-onboarding branch from 3a09e83 to 557d901 Compare April 23, 2026 15:14
@hanwencheng hanwencheng merged commit e585f97 into main Apr 23, 2026
1 check passed
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