Skip to content

docs(docs): add rich showcase planning artifacts#314

Merged
w7-mgfcode merged 1 commit into
devfrom
docs/showcase-prp-39-40-planning-artifacts
May 26, 2026
Merged

docs(docs): add rich showcase planning artifacts#314
w7-mgfcode merged 1 commit into
devfrom
docs/showcase-prp-39-40-planning-artifacts

Conversation

@w7-mgfcode
Copy link
Copy Markdown
Owner

Summary

What was added (11 files, +5974 / −0)

Umbrella + index + walkthrough (3)

  • PRPs/INITIAL/INITIAL-showcase-rich-demo-control-center.md — the parent INITIAL covering the four-PRP epic
  • PRPs/INITIAL/INITIAL-showcase-rich-demo-index.md — sequence + dependency index
  • docs/user-guide/showcase-walkthrough.md — visitor-facing walkthrough scaffold (filled in by PRP-41)

Per-PRP INITIALs (4)

  • PRPs/INITIAL/INITIAL-showcase-38-data-modeling-lifecycle.md — already-merged PRP-38 source-of-truth INITIAL
  • PRPs/INITIAL/INITIAL-showcase-39-decision-portfolio-lifecycle.md — patched for parallel PRP-create
  • PRPs/INITIAL/INITIAL-showcase-40-planning-knowledge-lifecycle.md — patched for parallel PRP-create
  • PRPs/INITIAL/INITIAL-showcase-41-agent-ops-polish.md

Generated PRPs + Task-1 contract-probe reports (4)

  • PRPs/PRP-39-showcase-decision-portfolio-lifecycle.md (1487 LOC, 18 tasks, confidence 8/10)
  • PRPs/PRP-40-showcase-planning-knowledge-lifecycle.md (1451 LOC, 17 tasks, confidence 8/10)
  • PRPs/ai_docs/prp-39-contract-probe-report.md (318 LOC)
  • PRPs/ai_docs/prp-40-contract-probe-report.md (343 LOC)

Already tracked (NOT duplicated)

PRP dependency graph

PRP-38 (merged on dev @ 3e771c9 — feat(api,ui) #309)
   │
   ├── PRP-39  decision + portfolio lifecycle      ← ready to execute
   │
   └── PRP-40  planning + knowledge lifecycle      ← ready to execute (parallel-safe with PRP-39)
           │
           └── PRP-41  agent + ops + polish        ← gated on BOTH PRP-39 + PRP-40

PRP-39 / PRP-40 parallel-readiness summary

Check Status
Both reference PRP-38 actual surfaces (file:line citations against app/features/demo/pipeline.py) ✅ verified — _phase_table@1118, _HTTP_TIMEOUT@77, _llm_key_present@221, step_v2_train@753 all alive on dev
No cross-PRP dependency ✅ PRP-40 line 12 + PRP-39 lines 232/1448 — either can merge first
No step-name collision ✅ PRP-39: step_{champion_compat_compare, stale_alias_trigger, safer_promote_flow, batch_preset}; PRP-40: step_{scenario_simulate_and_save, multi_plan_compare, embedding_provider_probe, rag_index_subset, rag_retrieve_probe}
No test-file collision ✅ Per-step test functions disjoint; both extend test_phase_table_* family in their own PR
Both use RELATIVE phase anchors (parallel-merge safety) ✅ PRP-39 inserts portfolio BEFORE the verify block; PRP-40 inserts planning + knowledge BEFORE verify — neither cites an absolute index
Both gate PRP-41 as out-of-scope ✅ PRP-39 line 17 + 1447; PRP-40 line 17 + 187 + 1366
Both preserve WebSocket StepEvent additive-only
Both preserve vertical-slice rule (no direct imports — only httpx.ASGITransport) ✅ Both PRPs include a git grep guard task
Both use pnpm tsc --noEmit -p tsconfig.app.json (not root tsc) ✅ PRP-39 lines 159/201/628/872; PRP-40 lines 585/1284/1314

Key decisions resolved in Task 1 (contract probes)

  • PRP-39 quick_baseline_sweep preset → Option A (client/demo-side expansion to existing BatchSubmitRequest{kind=MANUAL} shape; zero backend change). Live probe confirmed BatchSubmitRequest has no preset_id.
  • PRP-40 RAG sub-path filter (R18) → Option B (additive path_prefix: str | None = None on IndexProjectDocsRequest); ~5× faster than the wider-corpus fallback.
  • PRP-40 scenario run_idmodel_run.run_id mapping (R16) → two-call resolution: alias → run → artifact_uri → parse r"model_([0-9a-f]+)(?:\.joblib)?$". AliasResponse has no artifact_uri (drift finding documented in probe report).
  • PRP-40 method resolution (R17)ScenarioComparison.method is source-of-truth; surfaced in both step.detail and step.data.

Drift the PRPs patched vs INITIAL claims (sample)

  • INITIAL-39 cited RunCompareResponse.compatible; actual schema (app/features/registry/schemas.py:243-249) has only run_a/run_b/config_diff/metrics_diff — PRP derives compatibility client-side.
  • INITIAL-39 cited BatchSubmitResponse.item_count/completed_count; actual names are total_items/completed_items/failed_items/running_items/cancelled_items.
  • INITIAL-40 cited PriceAssumption.pct_change; actual is change_pct.
  • INITIAL-40 cited ScenarioComparison.aggregate_units_delta/aggregate_revenue_delta; actual are units_delta/revenue_delta.
  • INITIAL-40 cited HolidayAssumption.uplift_multiplier; the field doesn't exist (uplift is a constant in adjustments.py).
  • INITIAL-40 cited _llm_key_present() at line 203; actual is lines 221-237.

Both probe reports cite exact file:line for every cited surface.

Commit format

docs(docs): add rich showcase planning artifacts (#313)docs(showcase) is not in the commit-format scope allow-list (.claude/rules/commit-format.md); docs(docs) matches precedent (#283 / #296 / #283 / earlier).

Validation

  • ✅ 0 tracked modifications outside the 11 staged files
  • git diff --check clean (incl. CRLF-aware) on all 11 files
  • ✅ All 11 files LF-only, 0 trailing whitespace, 0 leading tabs, end with newline, max-consecutive-blank=1
  • ✅ qwen3 stash@{0} ("local qwen3 rag demo changes before prp-35") untouched
  • ✅ Pre-commit hook (check-commit-format.sh) passed

Out of scope (next PRs)

  • Execution of PRP-39 (/base_prp:prp-execute PRPs/PRP-39-…) — separate feat/showcase-39-… PR
  • Execution of PRP-40 (/base_prp:prp-execute PRPs/PRP-40-…) — separate feat/showcase-40-… PR (parallel-safe with PRP-39)
  • PRP-41 authoring + execution — gated on both PRP-39 + PRP-40 merging first

Test plan

This is a docs-only PR — no functional test required.

  • CI Lint & Format green
  • CI Type Check green
  • CI Test green
  • CI Migration Check green (no migrations touched)
  • Reviewer skim of PRP-39 + PRP-40 Implementation Blueprint sections + probe reports

Copy link
Copy Markdown

@sourcery-ai sourcery-ai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry @w7-mgfcode, your pull request is larger than the review limit of 150000 diff characters

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 26, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 749e04a2-831b-4776-beda-50060b4dfb5b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/showcase-prp-39-40-planning-artifacts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@w7-mgfcode w7-mgfcode merged commit 90a2c36 into dev May 26, 2026
8 checks passed
@w7-mgfcode w7-mgfcode deleted the docs/showcase-prp-39-40-planning-artifacts branch May 26, 2026 13:22
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