Skip to content

docs: blueprint user + dev guides (Phase 8, #68)#176

Merged
amaster97 merged 1 commit into
mainfrom
feat-premium-a-phase-8-docs
May 28, 2026
Merged

docs: blueprint user + dev guides (Phase 8, #68)#176
amaster97 merged 1 commit into
mainfrom
feat-premium-a-phase-8-docs

Conversation

@amaster97

Copy link
Copy Markdown
Owner

Summary

Premium-A Phase 8 documentation pass for the preflop blueprint feature
(task #68).

  • New docs/blueprint_user_guide.md (~190 lines) — plain-English
    end-user explainer: what the blueprint is, what ships in the .dmg,
    when to use blueprint vs custom solve, stack-depth coverage +
    interpolation behavior, ante config selection, FAQ (Nash multiplicity
    vs published charts, blueprint vs aggregator, regeneration).
  • New docs/blueprint_developer_guide.md (~370 lines) — engineering
    reference: how to regenerate blueprints (CLI flag matrix), asset +
    manifest schema, 169-class vs 1326-combo paths, True Path B engine
    internals, adding new depths or ante configs, blueprint → postflop
    subgame wiring, validation pipeline.
  • README.md — new "Preflop blueprint mode" section linking both docs.
  • USAGE.md §5.9 — Python API example using BlueprintLoader (Phase 2)
    and interpolate_strategy (Phase 3), plus the standard "what falls
    through to live solve" decision table.

All examples cite real shipped APIs and validation paths. PRs of
record cited: #163 (subplan), #167 (Phase 1 hybrid), #171 (True Path B
169-class kernel), #173 (interpolation), #174 (loader). Nash-
multiplicity caveat references
docs/preflop_100bb_chart_validation_v2_2026-05-28.md.

Test plan

  • All cross-reference paths resolved (no broken doc links).
  • Cited function names exist in source
    (BlueprintLoader.from_dir, .lookup, .actions,
    .available_depths, interpolate_strategy,
    solve_hunl_preflop_rvr_class169, Class169TerminalCache,
    build_class169_blocker_mass, _derive_continuation_ranges).
  • Cited code paths exist (poker_solver/blueprint.py,
    blueprint_loader.py, blueprint_interp.py, chained.py,
    scripts/generate_preflop_blueprint.py,
    crates/cfr_core/src/preflop_rvr.rs,
    assets/preflop_equity_169x169.npz,
    tests/test_blueprint_pipeline.py).
  • USAGE example compiles as valid Python syntax.
  • No aspirational "future work" language; docs describe what
    actually ships post-Phase-3.
  • No emojis added per memory feedback_no_extrapolate /
    task-brief rule.

Docs-only PR; auto-merge OK.

🤖 Generated with Claude Code

Premium-A Phase 8 documentation pass for the preflop blueprint feature
(task #68). Adds:

- docs/blueprint_user_guide.md (~190 lines) — end-user explainer:
  what the blueprint is, what ships in the .dmg, when to use blueprint
  vs custom solve, stack-depth coverage + interpolation behavior, ante
  config selection, common questions (Nash multiplicity vs published
  charts, blueprint vs aggregator, custom-range slowness).
- docs/blueprint_developer_guide.md (~370 lines) — engineering reference:
  how to regenerate blueprints (CLI flag matrix), asset + manifest
  schema, 169-class vs 1326-combo paths, True Path B engine internals,
  how to add new depths or ante configs, blueprint -> postflop subgame
  wiring, validation pipeline.
- README.md — new "Preflop blueprint mode" section linking both docs.
- USAGE.md §5.9 — Python API example using BlueprintLoader (Phase 2)
  and interpolate_strategy (Phase 3), with the standard "what falls
  through to live solve" decision table.

All examples cite real shipped APIs (BlueprintLoader.from_dir / .lookup
/ .actions / .available_depths; interpolate_strategy from
blueprint_interp). Validation references point to
preflop_100bb_chart_validation_v2_2026-05-28.md for Nash-multiplicity
divergence framing. PRs cited: #163 (subplan), #167 (Phase 1 hybrid),
#171 (True Path B 169-class kernel), #173 (interpolation),
#174 (loader).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@amaster97 amaster97 merged commit 44beb72 into main May 28, 2026
5 of 8 checks passed
amaster97 added a commit that referenced this pull request May 28, 2026
Updates README + USAGE to reflect v1.10.0 ship state (combined v1.9.0
Premium-A + v1.10 postflop optimization MINOR bump) per the v1.9.0
audit (task #69) findings. v1.9.0 was drafted but never tagged; both
docs were stuck at v1.8.x prose.

README.md (+150/-80 net):
- Status: bump v1.8.0 -> v1.10.0; strike v1.6.0 fork-bomb warning
  (resolved in v1.8.0 PR #42 727206e; left a historical mention of
  what was fixed)
- Preflop blueprint mode: expand from 3 sentences to a full section
  covering the four-API surface (BlueprintLoader/interp/subgame/
  SolverRouter), Phase 6 UI wiring (PR #178 chart widget source
  badges + chained tab + live-solve confirmation modal), B10
  per-combo editor (PRs #149/#154/#158/#160), Phase 7+8 docs
  (PRs #175/#176), and v1.10 flop unblock (task #70)
- "What's new in v1.10.0" replaces "Recent changes (since v1.8.0)";
  cites per-PR for Premium-A train + v1.10 postflop optimization
- UI section: chart widget + chained tab now consume real solver
  (PR #178); standalone ad-hoc tab still mock (PR 10b pending)
- Known issues: strike v1.6.0 fork-bomb (resolved), replace with
  ad-hoc-signing + arm64-only framing

USAGE.md (+185/-100 net):
- Header: v1.8.x -> v1.10.0; rewrite document baseline + v1.10.0
  section pointer paragraph
- Path A (.dmg): remove "DO NOT LAUNCH" warning, document Gatekeeper
  override flow for ad-hoc-signed bundle
- New §5.10 "CLI BB-normalization (v1.9.0; canonical in v1.10.0)"
  covering --pot N --stack M canonical flags + --pot-bb/--stack-bb
  deprecation warning (PR #152)
- §5.9 Preflop blueprint: extend with chained postflop subgame
  example (solve_postflop_from_blueprint, PR #177) + top-level
  SolverRouter example (PR #181) + honest perf framing (flop
  unblocked but benchmark numbers TBD)
- §7b Known perf cliffs: bump from v1.7.x to v1.10.0; document flop
  unblock from v1.9.0 OOM-killed; preserve aggregator-recommended
  framing for production-scale chart generation
- §7 Known limitations: bump from v1.0.0 to v1.10.0; UI partial-real
  framing (chart widget + chained tab real; standalone tab still mock)
- §8 What's coming: drop completed items; flag v1.10 perf benchmark
  publication as next-up + PR 10b standalone-tab swap
- --version output: bump 1.8.0 -> 1.10.0

Ship date: 2026-MM-DD placeholder; honest framing throughout that
flop top_k=169 wall numbers are TBD by combined-stack benchmark
(task #70 PRs #186-#190 + PR-1 arena + PR-3 vector flop).

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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