Skip to content

docs: sync docs with shipped scenario catalog#13

Merged
That1Drifter merged 2 commits intomasterfrom
docs/post-ship-scenarios
Apr 10, 2026
Merged

docs: sync docs with shipped scenario catalog#13
That1Drifter merged 2 commits intomasterfrom
docs/post-ship-scenarios

Conversation

@That1Drifter
Copy link
Copy Markdown
Owner

Summary

Post-ship documentation update following #12 (full scenario catalog) and catching stale copy from #11 (deterministic per-turn rubric scoring).

Documentation health

File Status Change
README.md Updated Pruned 3 "not yet built" items that have shipped (5 scenario manifests, deterministic rubric scoring, stakeholder conflict surprise). Refreshed Working list. Added docs/getting-started.md link under Quick start.
docs/architecture.md Updated Rewrote the scoring pipeline section — manifest rubric rules are wired now, not scaffolded. Documented case-insensitive + fail-closed regex behavior for both rubric and surprises.
docs/getting-started.md Updated "What's playable today" — all six scenarios loadable; support-triage and doc-qa-rag verified end-to-end on live API; the other four authored but not yet run.
docs/writing-scenarios.md Updated Added Objective rubric rules and Surprise triggers sections with explicit guidance not to use Perl-style (?i) inline flags (the engine applies i automatically now).
CONTRIBUTING.md Current No changes needed.
TODO.md Already updated Checked off in #12.
CLAUDE.md Skipped Gitignored (local-only).
CHANGELOG / VERSION N/A Neither file exists in this repo.

Test plan

  • Every link in the updated files points at a real path
  • Every claim cross-referenced against the current code (verified @fieldwork/rubric/score uses the i flag and fails closed; surprises.ts same)
  • Spot-read on GitHub after merge to catch any Markdown rendering issues

🤖 Generated with Claude Code

That1Drifter and others added 2 commits April 10, 2026 16:33
- README: prune "not yet built" items that shipped (5 scenario manifests,
  deterministic per-turn scoring, stakeholder conflict surprise) and refresh
  the Working list to reflect the current engine. Link getting-started.md
  from Quick start for discoverability.
- docs/architecture.md: rewrite the scoring-pipeline section — deterministic
  manifest rubric rules are wired now (not scaffolded), and document the
  case-insensitive + fail-closed regex behavior for both rubric and surprises.
- docs/getting-started.md: refresh "What's playable today" — all six
  scenarios are loadable, Support Triage and Doc Q&A are smoke-tested on
  live API, the other four are authored but not yet run.
- docs/writing-scenarios.md: add an Objective rubric rules section and a
  Surprise triggers section with explicit guidance not to use Perl-style
  (?i) inline flags — the engine now supplies the i flag automatically.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Previously gitignored as "local-only" but the content is pure project
guidance (monorepo layout, commands, two-Claude model, conventions) with
no secrets or personal paths. Committing makes it discoverable to new
contributors and Claude Code picks it up the same way.

Synced with this PR's other fixes while I was at it: rubric score.ts is
wired (not scaffolded), all six scenarios are authored (not just
support-triage), and the CLI section flags dryrun/play/cost-estimate/init
as TODO stubs so readers don't waste time on them.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@That1Drifter That1Drifter merged commit aaf1179 into master Apr 10, 2026
1 check passed
@That1Drifter That1Drifter deleted the docs/post-ship-scenarios branch April 10, 2026 21:36
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