Document alpha adoption path #42

Merged
pdurlej merged 2 commits from codex/docs-alpha-adoption into main 2026-05-19 00:34:52 +02:00
Collaborator

Canary Context Pack

Product story

Alpha users need a clear adoption path that tells them what fallow-ts is useful for today, how to run it from source or a future alpha package, and how to interpret findings without treating an alpha static report as deletion proof.

What changed

  • Added an Alpha Adoption Path to README.md with good/bad early fits.
  • Expanded docs/adoption.md with recommended first adoption, future fallow-ts@alpha install, baseline hygiene, agent-context prompt guidance, finding interpretation, and CI gate examples.
  • Recorded Wave 5 and Wave 6 bounded contexts in docs/roadmap.md so the parallel release train is durable in repo docs.
  • Added docs-test assertions for the new public adoption anchors.

Why it changed

This is Fork D / Adoption Documentation Context. It keeps user-facing alpha guidance factual while other forks own version identity, package distribution, and CI execution.

Files touched

  • README.md
  • docs/adoption.md
  • docs/roadmap.md
  • tests/docs.test.mjs

Relevant context

  • Based on main after PR #39 (Add release smoke for npm alpha).
  • Does not touch release identity, package scripts, CI workflows, release checklist, or analyzer behavior.

Runtime evidence

  • npm install --ignore-scripts (new isolated worktree only)
  • npm run build
  • npm test
  • node dist/cli.js analyze --root . --format json --output /tmp/fallow-ts-report.json
  • git diff --check

Known constraints

The fallow-ts@alpha commands are explicitly framed as the path after an alpha package is published. This PR does not publish or change the version.

Coordination notes

I found unrelated dirty Release Identity-style changes in /Users/pd/Developer/fallow-ts, so this PR was produced in an isolated worktree: /Users/pd/Developer/fallow-ts-fork-d. No files outside Fork D ownership were changed.

Explicit out-of-scope

No npm publish, version bump, release checklist edits, CI workflow changes, package metadata changes, parser/resolver changes, MCP work, or new analyzer categories.

Requested decision

Approve merge if the adoption copy is accurate and appropriately narrow for alpha users.

Merge blockers

Docs claiming behavior that does not exist, overlap with another bounded context, or language that implies deletion safety / official upstream affiliation.

## Canary Context Pack ### Product story Alpha users need a clear adoption path that tells them what `fallow-ts` is useful for today, how to run it from source or a future alpha package, and how to interpret findings without treating an alpha static report as deletion proof. ### What changed - Added an `Alpha Adoption Path` to `README.md` with good/bad early fits. - Expanded `docs/adoption.md` with recommended first adoption, future `fallow-ts@alpha` install, baseline hygiene, agent-context prompt guidance, finding interpretation, and CI gate examples. - Recorded Wave 5 and Wave 6 bounded contexts in `docs/roadmap.md` so the parallel release train is durable in repo docs. - Added docs-test assertions for the new public adoption anchors. ### Why it changed This is Fork D / Adoption Documentation Context. It keeps user-facing alpha guidance factual while other forks own version identity, package distribution, and CI execution. ### Files touched - `README.md` - `docs/adoption.md` - `docs/roadmap.md` - `tests/docs.test.mjs` ### Relevant context - Based on `main` after PR #39 (`Add release smoke for npm alpha`). - Does not touch release identity, package scripts, CI workflows, release checklist, or analyzer behavior. ### Runtime evidence - `npm install --ignore-scripts` (new isolated worktree only) - `npm run build` - `npm test` - `node dist/cli.js analyze --root . --format json --output /tmp/fallow-ts-report.json` - `git diff --check` ### Known constraints The `fallow-ts@alpha` commands are explicitly framed as the path after an alpha package is published. This PR does not publish or change the version. ### Coordination notes I found unrelated dirty Release Identity-style changes in `/Users/pd/Developer/fallow-ts`, so this PR was produced in an isolated worktree: `/Users/pd/Developer/fallow-ts-fork-d`. No files outside Fork D ownership were changed. ### Explicit out-of-scope No npm publish, version bump, release checklist edits, CI workflow changes, package metadata changes, parser/resolver changes, MCP work, or new analyzer categories. ### Requested decision Approve merge if the adoption copy is accurate and appropriately narrow for alpha users. ### Merge blockers Docs claiming behavior that does not exist, overlap with another bounded context, or language that implies deletion safety / official upstream affiliation.
Document alpha adoption path
Some checks failed
CI / test (push) Failing after 14s
CI / test (pull_request) Failing after 14s
f797585bb0
Clarifies how early users should adopt fallow-ts: source checkout, future alpha package install, demo flow, baseline flow, agent-context usage, finding interpretation, and the Wave 5/6 roadmap contexts.

Verified:

- npm install --ignore-scripts (new isolated worktree only)

- npm run build

- npm test

- node dist/cli.js analyze --root . --format json --output /tmp/fallow-ts-report.json

- git diff --check
codex requested review from claude 2026-05-18 18:53:39 +02:00
Merge remote-tracking branch 'origin/main' into codex/docs-alpha-adoption
All checks were successful
CI / test (push) Successful in 23s
CI / Node.js 20 (push) Successful in 11s
CI / Node.js 22 (push) Successful in 12s
CI / test (pull_request) Successful in 22s
CI / Node.js 20 (pull_request) Successful in 12s
CI / Node.js 22 (pull_request) Successful in 11s
9103898c41
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
pdurlej/fallow-ts!42
No description provided.