Skip to content

docs: restructure documentation, add CLI reference and workflows#4

Merged
montfort merged 2 commits intomainfrom
docs/restructure-and-versioning
Mar 19, 2026
Merged

docs: restructure documentation, add CLI reference and workflows#4
montfort merged 2 commits intomainfrom
docs/restructure-and-versioning

Conversation

@montfort
Copy link
Copy Markdown
Contributor

Summary

  • Add CLI-REFERENCE.md and WORKFLOWS.md for adopters (EN + ES) — fills the gap of missing CLI docs and daily usage patterns
  • Fix hardcoded v2.0.0 across 5 dist files and broken cookbook.md link in QUICK-REFERENCE.md
  • Update all docs to reflect independent fw-*/cli-* versioning scheme
  • Update releases/latest references to point users to fw-* tagged releases
  • Update CLI source tree in CONTRIBUTING.md (add update_framework.rs, status.rs)
  • Rewrite docs/README.md as a proper documentation hub with versioning section
  • Split framework/CLI versioning with independent release workflows

Test plan

  • Grep v2.0.0 in dist/ — 0 matches
  • Grep releases/latest across repo — 0 matches
  • Grep cookbook.md across repo — 0 matches
  • CLI commands table in README matches CLI-REFERENCE
  • All new files have language toggles linking EN ↔ ES
  • TRANSLATION-GUIDE scope includes new files

🤖 Generated with Claude Code

montfort and others added 2 commits March 18, 2026 23:00
Decouple framework and CLI release cycles so each component can evolve
independently. Framework uses `fw-*` tags, CLI uses `cli-*` tags, with
separate GitHub Actions workflows for each.

- Reset CLI version to 1.0.0, bump framework manifest to 2.1.0
- Add `get_latest_release_by_prefix()` to filter releases by tag prefix
- Add `strip_tag_prefix()` helper for fw-/cli-/v- prefixes
- Rename `update` command to `update-framework`, create combined `update`
- Add `update-framework` subcommand to CLI router
- Show both framework and CLI versions in `status` and `about`
- Split release.yml into release-framework.yml and release-cli.yml
- Update install scripts to fetch `cli-*` releases

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
…rsion fixes

Add CLI-REFERENCE.md and WORKFLOWS.md for adopters (EN + ES), update all
docs to reflect independent fw-*/cli-* versioning, fix broken cookbook.md
link, remove hardcoded v2.0.0 from dist files, and update releases/latest
references to point to fw-* releases.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Mar 19, 2026

CLA assistant check
All committers have signed the CLA.

@montfort montfort merged commit e3f8e78 into main Mar 19, 2026
montfort added a commit that referenced this pull request May 2, 2026
Editorial-only pass on Propuesta/devtrail-design-principles.md to remove
internal-language phrases that confuse readers who don't know Sentinel
(the project that produced the empirical evidence). All decisions and
commitments preserved; only language generalized.

Specific changes:
- Version metadata now names the editorial pass and dates it.
- v0.2 anotaciones intro: glosses Sentinel as "un sistema Go backend"
  on first mention, drops references to /plan-audit and PLAN-NN that
  cold readers can't anchor to anything.
- Principle #6 anotación (virtud-vs-ceremonia): replaces specific
  artifact IDs (AILOG-020, AILOG-022, PLAN-05.telemetry.yaml) with
  abstracted descriptions of the empirical findings. The decisions
  about what counts as virtud vs ceremonia stay identical.
- Principle #9 anotación (bash before framework): drops the script
  filename and AILOG ref, keeps the ~145-line metric and the
  three-property justification (zero-build, no deps, in-situ
  inspection).
- Principle #12 anotación (N≥3 spirit): "Sentinel es un solo
  proyecto..." → "La evidencia empírica disponible proviene de un
  solo proyecto adoptante..."; specific scores (9.25/9.5) generalized
  to "scores similares"; supuesto #4 named as "supuesto de
  aprobaciones condicionales" instead of by number alone.
- Meta-meta paragraph: drops Sentinel-specific framing while keeping
  the auto-evolución insight intact.

Prerequisite for D4 of the README repositioning plan: link the design
principles from the public README. Cold readers (a developer landing
on GitHub, not someone who read all the propuesta docs) need to grasp
each principle without first decoding internal artifacts.

Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
montfort added a commit that referenced this pull request May 2, 2026
Reframes DevTrail's canonical English surface from "AI Governance Platform" to
engineering-discipline-first, with compliance positioned as a side effect.
Aligns the README, DEVTRAIL.md, and DOCUMENTATION-POLICY.md with Principle #4
(compliance is a side effect, not the product) and Principle #2 (primary user
is the senior engineer orchestrating agents). Spanish and zh-CN translations
deferred to a follow-up i18n release.

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.

2 participants