Skip to content

docs(vbrief): update ancillary framework docs for vBRIEF-centric model#346

Merged
MScottAdams merged 2 commits intophase2/vbrief-cutoverfrom
agent2/docs/331-ancillary-doc-updates
Apr 13, 2026
Merged

docs(vbrief): update ancillary framework docs for vBRIEF-centric model#346
MScottAdams merged 2 commits intophase2/vbrief-cutoverfrom
agent2/docs/331-ancillary-doc-updates

Conversation

@MScottAdams
Copy link
Copy Markdown
Collaborator

Summary

Closes #331

Update all ancillary framework documents for the vBRIEF-centric document model introduced in RFC #309.

Story D (#313) covers main.md and AGENTS.md; this story covers everything else.

Changes

Core reference docs

  • REFERENCES.md: PROJECT.md -> PROJECT-DEFINITION.vbrief.json throughout loading scenarios, reference chains, and common scenarios; updated vbrief.md description to reflect lifecycle folders and scope vBRIEFs
  • README.md: Skill names deft-* -> deft-directive-* in directory tree and Skills listing; directory structure updated with lifecycle folders (proposed/, pending/, active/, completed/, cancelled/) and PROJECT-DEFINITION.vbrief.json; Your Artifacts section rewritten for scope vBRIEF model
  • CONTRIBUTING.md: CLI command descriptions updated for scope vBRIEFs and PROJECT-DEFINITION

Workflow docs

  • commands.md: Spec delta merge section updated to target scope vBRIEFs instead of SPECIFICATION.md
  • strategies/interview.md: deft-setup -> deft-directive-setup; implementation target updated to scope vBRIEFs in ./vbrief/active/
  • strategies/map.md: PROJECT.md -> PROJECT-DEFINITION.vbrief.json for strategy invocation
  • strategies/speckit.md: PROJECT.md -> PROJECT-DEFINITION.vbrief.json for strategy invocation
  • templates/make-spec.md: Spec flow rewritten to produce scope vBRIEFs in proposed/ lifecycle folder with scope:promote workflow; PROJECT.md -> PROJECT-DEFINITION.vbrief.json

Context and resilience docs

  • context/working-memory.md: plan.vbrief.json + scope vBRIEF planRef relationship (RFC D15); lifecycle folders and PROJECT-DEFINITION added as non-scratch files
  • resilience/continue-here.md: continue.vbrief.json + scope vBRIEF planRef (RFC D15); scope vBRIEFs distinguished from ephemeral checkpoints
  • context/long-horizon.md: planRef to scope vBRIEFs on resume; scope:complete lifecycle transition; anti-pattern for scratch misuse of scope vBRIEFs

Checklist

  • CHANGELOG.md entry added under [Unreleased]
  • task check passes (1242 tests, 0 failures)
  • No remaining references to PROJECT.md as project config in updated files (except deprecation context)
  • All deft-* skill name references updated to deft-directive-* in updated files
  • PR targets phase2/vbrief-cutover (not master)
  • Greptile review cycle completed
  • No new source files (docs-only change -- no test files required)

Related

#331)

- REFERENCES.md: PROJECT.md -> PROJECT-DEFINITION.vbrief.json, lifecycle folders
  and scope vBRIEFs in loading scenarios, reference chains, and common scenarios
- README.md: skill names deft-* -> deft-directive-*, directory structure with
  lifecycle folders and scope vBRIEFs, Your Artifacts section rewritten
- CONTRIBUTING.md: CLI command descriptions updated for scope vBRIEFs
- commands.md: spec delta merge targets scope vBRIEFs instead of SPECIFICATION.md
- strategies/interview.md: deft-setup -> deft-directive-setup, implementation
  target updated to scope vBRIEFs in ./vbrief/active/
- strategies/map.md, strategies/speckit.md: PROJECT.md -> PROJECT-DEFINITION
- templates/make-spec.md: spec flow rewritten to produce scope vBRIEFs in
  proposed/ lifecycle folder with scope:promote workflow
- context/working-memory.md: plan.vbrief.json + scope vBRIEF planRef (D15),
  lifecycle folders and PROJECT-DEFINITION as non-scratch
- resilience/continue-here.md: continue.vbrief.json + scope vBRIEF planRef (D15),
  scope vBRIEFs distinguished from ephemeral checkpoints
- context/long-horizon.md: planRef to scope vBRIEFs on resume, scope:complete
  lifecycle transition, anti-pattern for scratch misuse
- CHANGELOG.md: added [Unreleased] entry for Story P

Part of Phase 2 vBRIEF Architecture Cutover (RFC #309).
@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 13, 2026

Greptile Summary

This PR updates 11 ancillary framework documents to align with the vBRIEF-centric model introduced in RFC #309: replacing PROJECT.md references with PROJECT-DEFINITION.vbrief.json, renaming deft-* skills to deft-directive-*, introducing lifecycle folder paths (proposed/, pending/, active/, completed/, cancelled/), and wiring plan.vbrief.json / continue.vbrief.json planRef relationships per RFC D15. Changes across context/, resilience/, commands.md, strategies/, and templates/ are internally consistent. Two small discrepancies: the implementation-target folder in interview.md says active/ while make-spec.md says pending/ (the correct lifecycle state at spec-completion), and README.md's numbered Rule Hierarchy text still shows project.md while the Mermaid diagram directly above it was updated to PROJECT-DEFINITION.vbrief.json.

Confidence Score: 5/5

Safe to merge; all findings are P2 style/consistency nits with no behavioral or data-integrity impact.

Both remaining findings are P2: one is a folder name mismatch in an explanatory user prompt (no runtime effect), the other is a stale label in a text list that contradicts the diagram above it. No logic errors, no broken references in tested paths, and the checklist's 1242-test pass confirms the mechanical changes are sound.

strategies/interview.md (implementation target folder) and README.md (Rule Hierarchy text list)

Important Files Changed

Filename Overview
strategies/interview.md Updated skill name to deft-directive-setup and implementation target to ./vbrief/active/; implementation target conflicts with make-spec.md which says ./vbrief/pending/
templates/make-spec.md Spec flow correctly rewritten to produce scope vBRIEFs in proposed/ with scope:promote workflow; Afterwards section correctly directs users to pending/
README.md Skills listing and directory tree correctly updated to deft-directive-* and lifecycle folders; Rule Hierarchy text list (line 459) still shows project.md while the Mermaid diagram above shows PROJECT-DEFINITION.vbrief.json
REFERENCES.md Loading scenarios and reference chains correctly updated to PROJECT-DEFINITION.vbrief.json with lifecycle folder descriptions
CONTRIBUTING.md CLI command descriptions correctly updated for scope vBRIEFs and PROJECT-DEFINITION.vbrief.json
commands.md Spec delta merge section correctly updated to target scope vBRIEFs instead of SPECIFICATION.md
context/working-memory.md Correctly updated with plan.vbrief.json + scope vBRIEF planRef relationship and all 5 lifecycle folders listed as durable non-scratch files
resilience/continue-here.md Correctly updated with continue.vbrief.json + scope vBRIEF planRef (RFC D15) and distinction between ephemeral checkpoints and durable scope vBRIEFs
context/long-horizon.md Correctly updated with planRef to scope vBRIEFs on resume, scope:complete lifecycle transition, and anti-pattern for scratch misuse
strategies/map.md Invoking strategy section correctly updated to PROJECT-DEFINITION.vbrief.json; no other required changes
strategies/speckit.md Invocation section correctly updated to PROJECT-DEFINITION.vbrief.json; internal project.md references are SpecKit-specific artifacts (Principles doc), intentionally distinct from global config
CHANGELOG.md CHANGELOG entry correctly added under [Unreleased] with accurate description of all 11 updated framework documents

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart LR
    subgraph spec ["Spec Generation Flow (make-spec.md / interview.md)"]
        A["Interview\ncomplete"] --> B["Write scope vBRIEF\nto proposed/\nstatus: draft"]
        B --> C["User reviews\n& approves"]
        C --> D["scope:promote\n→ pending/\nstatus: approved"]
        D --> E["User says:\n'implement vBRIEFs\nin pending/'"]
        E --> F["scope:activate\n→ active/\nstatus: running"]
        F --> G["Implementation"]
        G --> H["scope:complete\n→ completed/"]
    end

    style A fill:#c4b5fd,stroke:#7c3aed,color:#000
    style B fill:#fef08a,stroke:#ca8a04,color:#000
    style C fill:#fde68a,stroke:#d97706,color:#000
    style D fill:#93c5fd,stroke:#2563eb,color:#000
    style E fill:#f0abfc,stroke:#a21caf,color:#000
    style F fill:#6ee7b7,stroke:#059669,color:#000
    style G fill:#7dd3fc,stroke:#0284c7,color:#000
    style H fill:#86efac,stroke:#16a34a,color:#000
Loading
Prompt To Fix All With AI
This is a comment left during a code review.
Path: strategies/interview.md
Line: 432-434

Comment:
**Implementation target folder mismatch with make-spec.md**

This prompt tells the user to implement from `./vbrief/active/`, but at the end of spec generation the scopes land in `./vbrief/pending/` (after `scope:promote`). `templates/make-spec.md` line 162 explicitly says to tell users `"implement the scope vBRIEFs in ./vbrief/pending/"`, which is consistent with the lifecycle flow (pending → activate → active). A user following this prompt would find nothing in `active/`.

```suggestion
implement the scope vBRIEFs in ./vbrief/pending/
```

How can I resolve this? If you propose a fix, please make it concise.

---

This is a comment left during a code review.
Path: README.md
Line: 454-464

Comment:
**Rule Hierarchy text inconsistent with diagram above it**

The Mermaid layer diagram directly above this section (line 172) correctly shows `PROJECT-DEFINITION.vbrief.json` as the second precedence layer, but the numbered text list still says `project.md`. This same file's PR scope included the precedence diagram update; the text list should match.

```suggestion
2. **PROJECT-DEFINITION.vbrief.json** - project-specific rules
```

How can I resolve this? If you propose a fix, please make it concise.

Reviews (2): Last reviewed commit: "fix: address Greptile review findings (b..." | Re-trigger Greptile

Comment thread launch-agent.ps1 Outdated
- Remove accidentally committed launch-agent.ps1 (agent driver script)
- Update strategies/interview.md PROJECT.md Override section to reference
  PROJECT-DEFINITION.vbrief.json (with deprecated PROJECT.md fallback)
- Update README.md mermaid rule precedence diagram to show
  PROJECT-DEFINITION.vbrief.json instead of PROJECT.md

MCP unavailable in this session -- used gh api fallback for review comments.
@MScottAdams MScottAdams merged commit a09782c into phase2/vbrief-cutover Apr 13, 2026
3 checks passed
@MScottAdams MScottAdams deleted the agent2/docs/331-ancillary-doc-updates branch April 13, 2026 20:29
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