Skip to content

docs(content): purge stale core refs, add strategy stubs, getting-started stub (#51, #112)#260

Merged
MScottAdams merged 4 commits intomasterfrom
agent3/docs/51-112-strategy-stubs
Apr 9, 2026
Merged

docs(content): purge stale core refs, add strategy stubs, getting-started stub (#51, #112)#260
MScottAdams merged 4 commits intomasterfrom
agent3/docs/51-112-strategy-stubs

Conversation

@MScottAdams
Copy link
Copy Markdown
Collaborator

Summary

Three content/doc fixes for Phase 2 backlog items:

Task A: Purge stale core/ references (t2.1.1, #51)

  • Updated all non-history .md files referencing legacy core/user.md and core/project.md paths to canonical locations (~/.config/deft/USER.md and ./PROJECT.md)
  • 42 files changed across languages, platforms, scm, coding, meta, main.md, REFERENCES.md, SKILL.md, ROADMAP.md, PRD.md
  • Flipped 4 deprecated-path xfail entries in known_failures.json

Task B: Strategy stubs (t2.8.5, roadmap)

  • Created strategies/rapid.md -- quick prototyping workflow (SPECIFICATION-only, forced-Light, minimal gates)
  • Created strategies/enterprise.md -- compliance-heavy workflow (PRD -> ADR -> SPECIFICATION, explicit approval gates)
  • Both have RFC2119 legend, See also banner, full workflow structure, and anti-patterns
  • Updated strategies/README.md: removed (future) annotations, added links
  • Added test assertions and flipped xfail entries

Task C: Getting-started stub (t2.8.6, #112)

Checklist

  • SPECIFICATION.md has task coverage (t2.1.1, t2.8.5, t2.8.6)
  • CHANGELOG.md entry under [Unreleased]
  • task check passes (972 passed, 19 xfailed)
  • Feature branch (not direct to master)

Closes #51 (partial -- purge stale refs portion)
Ref #112 (stub only -- full content deferred)

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Apr 9, 2026

Greptile Summary

This PR completes three Phase 2 backlog items: purges legacy core/user.md / core/project.md path references across 42 files, adds strategies/rapid.md and strategies/enterprise.md stubs, and creates a docs/getting-started.md placeholder. Prior review concerns (UTF-8 encoding corruption and the double-pipe enterprise.md table row) have been addressed in subsequent fix commits.

Confidence Score: 5/5

Safe to merge — all findings are P2 style suggestions with no functional impact.

The only remaining finding is a one-line stale comment in a docstring; all prior P0/P1 concerns (encoding corruption, broken table row) were resolved in fix commits. Path-replacement sweep is verified clean, xfail entries are correctly toggled, and all cross-references in the new strategy files resolve.

tests/content/test_structure.py — stale module docstring (P2 only).

Vulnerabilities

No security concerns identified. Changes are documentation and test-structure only; no code paths, secrets handling, or authentication logic is affected.

Important Files Changed

Filename Overview
strategies/rapid.md New strategy stub for quick-prototyping workflow; RFC2119 legend, workflow steps, and anti-patterns are well-formed; all cross-references (interview.md, yolo.md, README.md) resolve to existing files.
strategies/enterprise.md New strategy stub for compliance-heavy workflow with PRD→ADR→SPECIFICATION gates; RFC2119 legend, approval gates, and anti-patterns are well-formed; all cross-references resolve.
strategies/README.md Removed "(future)" annotations from rapid.md and enterprise.md rows and added proper markdown links; table formatting is correct with single leading pipe on all rows.
docs/getting-started.md New stub file with explicit deferred-content note and placeholder section headings; intentionally incomplete per PR description.
tests/content/test_structure.py Three new explicit test functions added for rapid.md, enterprise.md, and getting-started.md; module docstring still describes rapid/enterprise as xfail-future which is now stale.
tests/content/snapshots/known_failures.json Eight xfail entries correctly flipped to xfail:false covering strategy file existence, deprecated-path checks, and contracts link checks; no orphaned active xfails remain.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    CG[Chaining Gate] --> |spec-generating| RS[rapid strategy\nForced-Light path]
    CG --> |spec-generating| ES[enterprise strategy\nForced-Full path]
    CG --> |spec-generating| IS[interview strategy\nSizing gate]
    RS --> SPEC1[SPECIFICATION.md\ndraft status]
    ES --> PRD[PRD.md\nGate 1: approval]
    PRD --> ADR[docs/adr/*.md\nGate 2: approval]
    ADR --> SPEC2[SPECIFICATION.md\nGate 3: approval]
    IS --> SPEC3[SPECIFICATION.md]
    SPEC1 --> BUILD1[Build\nrelaxed gates ≥50%]
    SPEC2 --> BUILD2[Build\nfull gates ≥85%]
    SPEC3 --> BUILD3[Build\nstandard gates]
Loading
Prompt To Fix All With AI
This is a comment left during a code review.
Path: tests/content/test_structure.py
Line: 9

Comment:
**Stale docstring comment**

The module-level docstring still describes `rapid.md` and `enterprise.md` as `xfail — listed as future`, but both files have now been created by this PR. Anyone reading this docstring will get an inaccurate picture of the test suite's coverage.

```suggestion
    (rapid.md and enterprise.md now exist — xfail entries removed in t2.8.5)
```

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

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

Comment thread strategies/README.md Outdated
Comment thread languages/c.md Outdated
…rted stub (#51, #112)

- Purge all stale core/user.md and core/project.md references from
  non-history .md files (t2.1.1, #51); update 22 language files,
  2 platform files, scm/git.md, coding/coding.md, meta files,
  main.md, REFERENCES.md, SKILL.md, ROADMAP.md, PRD.md
- Create strategies/rapid.md (quick prototyping, forced-Light path,
  minimal gates) and strategies/enterprise.md (compliance-heavy,
  PRD -> ADR -> SPECIFICATION with approval gates) (t2.8.5)
- Update strategies/README.md: remove (future) annotations, add links
- Create docs/getting-started.md stub with deferred-content note and
  placeholder section outline (t2.8.6, #112)
- Add test assertions for rapid.md, enterprise.md, getting-started.md
  in tests/content/test_structure.py
- Flip xfail entries in known_failures.json for rapid.md, enterprise.md,
  and 4 deprecated-path entries now fixed
- Add CHANGELOG entries under [Unreleased]
- Fix double-pipe on enterprise row in strategies/README.md (P2:
  broken table rendering + silently dropped parametrized test coverage)
- Fix RFC2119 notation in strategies/enterprise.md: change ~ (SHOULD)
  to ! (MUST) for /deft:change rule that is explicitly mandatory
- README.md core/project.md ref (P2) not fixed: file is in the
  do-not-touch constraint list for this PR
- Mark SPECIFICATION.md t2.1.1 as [completed]
- README.md core/project.md ref (P1) not fixed: file is in the
  do-not-touch constraint list for this agent's PR scope
- Fix encoding corruption (P0): restore 26 language/platform/scm files
  from master and re-apply core/project.md replacement using Python
  (PowerShell Get-Content double-encoded UTF-8, corrupting RFC2119 symbols)
- Fix duplicate deft/PROJECT.md in SKILL.md example (P1): remove
  duplicated path entry in framework-internal example list
@MScottAdams MScottAdams force-pushed the agent3/docs/51-112-strategy-stubs branch from 2eba0c9 to b33dc8e Compare April 9, 2026 18:03
@MScottAdams MScottAdams merged commit 16a95dc into master Apr 9, 2026
9 checks passed
@MScottAdams MScottAdams deleted the agent3/docs/51-112-strategy-stubs branch April 9, 2026 18:07
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.

Project should be fully bootstrapped with its own framework

1 participant