docs: how-to guide for wiring a capability into the reference implementation - #3094
docs: how-to guide for wiring a capability into the reference implementation#3094sei-ahouseholder wants to merge 3 commits into
Conversation
…nce implementation Closes #2974 Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
|
[ADVISORY] Code review finding — not blocking The code review noted that returning |
sei-ahouseholder
left a comment
There was a problem hiding this comment.
PR Triage Report
PR #3094 — docs: how-to guide for wiring a capability into the reference implementation
Summary
Docs-only PR. Adds docs/howto/wire_capability.md — a step-by-step how-to for replacing a call-out stub with real backend logic. No Python code changes.
| Phase | Result |
|---|---|
| Issue linkage (#2974) | ✅ All 5 ACs satisfied |
| PR body format | ✅ Correct structure, Co-authored-by present |
| Domain context | ✅ Docs only: docs/howto/, mkdocs.yml, docs/_acronyms/index.md |
| Spec conformance (DF-04) | ✅ Goal-oriented, task-structured, prerequisites linked |
| ADR check | ✅ No ADR needed (docs-only, no architectural change) |
| AGENTS.md compliance | ✅ No Python code, MD013 disabled in linter config |
| Code reference accuracy | ✅ All referenced symbols and paths verified to exist |
| Notes / docs currency | ✅ No notes need updating; source notes unchanged |
| Test coverage | ✅ Docs-only PR, no tests required |
| CI status | ✅ All 5 checks passing (lint, docs-build-check, CodeQL, Analyze ×2) |
| Merge state | ✅ MERGEABLE / CLEAN |
Findings
None. This PR is ready for execute/verify.
Verification against AC
- AC-1 ✅ Step 1 covers fuzzer-node discovery + blackboard contract reading
- AC-2 ✅ Step 2 covers
CallOutBackendFactoryimplementation patterns (with/without blackboard writes) - AC-3 ✅ Full worked example:
EvaluateReportCredibilityend-to-end - AC-4 ✅
mkdocs.ymlnav updated under How-to Guides - AC-5 ✅
docs-build-checkCI job: pass (149s, no errors)
sei-ahouseholder
left a comment
There was a problem hiding this comment.
PR Execute Report
PR #3094 — docs: how-to guide for wiring a capability into the reference implementation
Findings Processed
None — triage found 0 findings.
CI Loop
| Step | Result |
|---|---|
| Sync with main | ✅ Merged origin/main (58be810) cleanly — skill doc updates only |
| Local tests | ✅ 8273 passed, 27 xfailed, 0 failures |
| Push | ✅ Pushed 98036847d |
| CI | ✅ All 5 checks passing |
Final State
- Merge state: MERGEABLE / CLEAN
- CI: passing (CodeQL, docs-build-check, lint, Analyze ×2)
- Draft: no
sei-ahouseholder
left a comment
There was a problem hiding this comment.
PR Verify Report
PR #3094 — docs: how-to guide for wiring a capability into the reference implementation
Findings
| # | Finding | Outcome | Verdict |
|---|---|---|---|
| — | (none) | — | — |
No findings from triage — nothing to spot-verify.
Status
| Check | Result |
|---|---|
| Merge state | ✅ MERGEABLE / CLEAN |
| CI | ✅ All 5 checks passing (CodeQL, docs-build-check, lint, Analyze ×2) |
| Findings verified | ✅ 0 of 0 |
| Draft | ✅ Not a draft |
| Branch behind | ✅ Up to date |
Overall Verdict
READY-TO-MERGE
PR #3094 is clear: zero triage findings, all CI checks green, MERGEABLE/CLEAN.
Summary
Adds
docs/howto/wire_capability.md: a step-by-step how-to guide for developers who want to replace a call-out stub in the Vultron reference implementation with real logic. Covers the three-step process (identify → implement → wire) with a full worked example usingEvaluateReportCredibility. Also adds the page to themkdocs.ymlHow-to Guides nav.Changes
docs/howto/wire_capability.md: new how-to covering call-out point identification (fuzzer node table, blackboard contract),CallOutBackendFactoryimplementation with the requiredsetup()+attach_blackboard_client()+register_key()pattern, domain bundle wiring, tree builder integration, and a complete worked example.mkdocs.yml: addsWiring a Capability: 'howto/wire_capability.md'to the How-to Guides nav section.Verification
uv run mkdocs build --strictpasses (149s, no errors or warnings)setup()+attach_blackboard_client()pattern (caught and fixed in pre-PR code review)