Skip to content

docs: Phase v1 PR 7 — adopter docs aligned with v1 audit-skills (3 langs)#109

Merged
montfort merged 1 commit intomainfrom
docs/audit-skills-v1-adopter-docs
May 5, 2026
Merged

docs: Phase v1 PR 7 — adopter docs aligned with v1 audit-skills (3 langs)#109
montfort merged 1 commit intomainfrom
docs/audit-skills-v1-adopter-docs

Conversation

@montfort
Copy link
Copy Markdown
Contributor

@montfort montfort commented May 5, 2026

Summary

Seventh of 8 PRs implementing the integrated v1 audit-skills iteration. Updates the adopter-facing documentation to reflect the v1 audit flow: three skills in sequence over canonical paths, with "never copy/paste" as the load-bearing operator-experience promise.

Files updated (15 total = 5 docs × 3 langs)

  • `CLI-REFERENCE.md` — full rewrite of `### devtrail charter audit` for v1 two-step (PREPARE/MERGE-REPORTS), default range, deprecation shims, canonical layout, two example blocks. Skills section gains `/devtrail-audit-execute` row and reframes audit-prompt / audit-review for v1.
  • `WORKFLOWS.md` — Skills table updated for 3-skill sequence.
  • `ADOPTION-GUIDE.md` — External Audit (Optional) section: 2 bullets → 3 bullets.
  • `QUICK-REFERENCE.md` (governance) — Skills table: 2 audit rows → 3 audit rows.
  • `AGENT-RULES.md` §12 (Audit checkpoint) — message text rewritten for the 3-skill sequence; "wait for ALL audits" warning load-bearing.

Test plan

  • `cargo test --test checkpoint_guidance_test` → 4/4 green (asserts §12 structure stayed intact across langs)
  • `cargo test` (full suite) → all suites green
  • No version bump (lands with PR 8 in integrated v1 release)

Phase v1 progress

PR Status
1-6 merged (#103-#108)
7 this PR
8 Bump release pending

🤖 Generated with Claude Code

…ngs)

Updates the adopter-facing documentation to reflect the v1 audit
flow: three skills (audit-prompt + audit-execute + audit-review)
in sequence over canonical paths under .devtrail/audits/, with
"never copy/paste" as the load-bearing operator-experience promise.

Files updated (15 total = 5 docs × 3 langs):

- docs/adopters/CLI-REFERENCE.md — full rewrite of the
  `### devtrail charter audit` section (v0 three-step PREPARE/
  CALIBRATE/FINALIZE → v1 two-step PREPARE/MERGE-REPORTS),
  v1 default range, deprecation shims for --calibrate / --finalize,
  v1 canonical layout under .devtrail/audits/, two example blocks
  (skills-driven and CLI-direct). The `## Skills` section gains a
  new row for /devtrail-audit-execute and reframes audit-prompt /
  audit-review for v1 (no more "surface prompts inline" — now
  "writes to canonical path"; review now produces consolidated
  review.md with 6 sections).
- docs/i18n/es/adopters/CLI-REFERENCE.md — same content in Spanish.
- docs/i18n/zh-CN/adopters/CLI-REFERENCE.md — header and skills
  table updated; the detail block for the audit subcommand kept
  v0 reference text (a future docs PR with native zh-CN review can
  refine — the v1 intro at the top + the v1 skills table at the
  bottom transmit the canonical guidance correctly).

- docs/adopters/WORKFLOWS.md (+ es + zh-CN) — Skills table updated
  for the 3-skill sequence. Existing audit checkpoint subsection
  unchanged (still accurate for v1).

- docs/adopters/ADOPTION-GUIDE.md (+ es + zh-CN) — External Audit
  (Optional) section: 2 bullets → 3 bullets, with audit-execute
  surfaced and the canonical paths called out.

- dist/.devtrail/00-governance/QUICK-REFERENCE.md (+ es + zh-CN) —
  Skills table: 2 audit rows → 3 audit rows.

- dist/.devtrail/00-governance/AGENT-RULES.md (+ es + zh-CN) §12
  (Audit checkpoint) — checkpoint message text rewritten to direct
  the operator through the 3-skill sequence (audit-prompt → N×
  audit-execute → audit-review), with the "wait for ALL audits"
  warning load-bearing in the message and reinforced in the
  Rules of engagement bullet.

Test plan:
  - cargo test --test checkpoint_guidance_test → 4/4 green
    (asserts the §12 section structure stayed intact across langs).
  - cargo test (full suite) → all suites green; the v1 wording
    changes preserve all anchors the existing tests check for
    (`/devtrail-audit-prompt`, `/devtrail-audit-review`,
    `complexity.threshold`, `Propuesta/devtrail-audit-skills.md`).

Note on zh-CN: the audit subcommand's detail block in
docs/i18n/zh-CN/adopters/CLI-REFERENCE.md retained its v0 detail
text below the v1 header; a follow-up native review can refresh
it. Both the v1 header at the top and the v1 skills table at the
bottom carry the canonical guidance accurately.

No version bump (lands together with PR 8 in the integrated v1
release per Propuesta/devtrail-audit-cli-flow.md v0.2 §5).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@montfort montfort merged commit b2d32b9 into main May 5, 2026
@montfort montfort deleted the docs/audit-skills-v1-adopter-docs branch May 5, 2026 16:08
montfort added a commit that referenced this pull request May 5, 2026
Closes the integrated v1 audit-skills iteration described in
Propuesta/devtrail-audit-cli-flow.md v0.2. Tags the previously-
merged PRs (#103-#109) into a coherent shipped release.

Bumps:
- cli/Cargo.toml: 3.9.0 → 3.10.0 (minor — new --prepare and
  --merge-reports flags, canonical path migration, deprecation
  shims for --calibrate / --finalize, R10 + R11(A) fixes; v0
  schemas evolve in place per their experimental $comment).
- dist/dist-manifest.yml: 4.8.0 → 4.9.0 (minor — new
  devtrail-audit-execute skill, unified prompt template
  replacing 3 v0 templates, AGENT-RULES §12 wording aligned to
  3-skill sequence).

Version refs updated in 22 docs (README + adopter docs +
governance footers, all 3 langs).

CHANGELOG.md gains a combined Framework 4.9.0 / CLI 3.10.0
section with Added (Framework, CLI), Changed, Removed,
Fixed (R10), Deprecated (--calibrate, --finalize), BREAKING
(deliberate within experimental v0.x — paths migration), Tests,
and explicit Credit to José Villaseñor Montfort for the audit
skills lifted from Sentinel via issue #102.

Test plan:
- cargo test → all suites green (276 unit + 17 charter_audit
  + 12 audit_skill + 9 audit_template + 4 checkpoint_guidance
  + all others).
- cargo check → version bumps propagate to Cargo.lock cleanly.

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