Skip to content

docs: opt into the Spanish-docs regime - #5

Merged
ddespinoza merged 1 commit into
mainfrom
docs/spanish-docs-optin
Oct 18, 2026
Merged

ddespinoza merged 1 commit into
mainfrom
docs/spanish-docs-optin

Conversation

@ddespinoza

Copy link
Copy Markdown
Contributor

Pilot of the per-repo docs migration (repo-docs ADR 0006).

  • Adds .github/docs-es and refreshes the vendored repo-docs.py and profiles to the current canon (documentation ships the same bytes).
  • Rewrites README.md in Spanish with the five-section contract; the full explanation already lives in documentation/desarrollo/aps-common.md.
  • Deletes the retired docs/index.md (no code reads it).
  • CONTEXT.md, the ADR and the CHANGELOG stay (English, dated history).

Verified: python3 .github/repo-docs.py check . --offline → 0 errors. Docs-only; no src/ or js/ change.

🤖 Generated with Claude Code

…index.md

The prose for people lives in APS-Conecta/documentation (repo-docs ADR 0006).
Adds .github/docs-es, refreshes the vendored checker and profiles to the
current canon, rewrites the README to the five-section contract and drops the
retired docs/index.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>

Copy link
Copy Markdown
Contributor Author

🤖 Claude review — ✅ Ready to merge

A docs-only pilot of the repo-docs ADR 0006 migration. It adds an empty .github/docs-es marker, re-vendors repo-docs.py and both profiles (stamp 9da993705f95), rewrites README.md in Spanish with the five docs_es_sections (Qué es · Documentación · Estado · Inicio rápido de desarrollo · Licencia), and deletes docs/index.md, which the new profile lists under retired_paths. Every fact in the old English README survives in the new one: the consumer blast radius, the aps-sync/aps-drift flow, the PHP ^8.1 floor and why, the PSR-4 autoloader, and ADR-0001. The Licencia section carries the required aps-conecta.github.io/documentation…aviso link. Nothing outside .github/, README.md, CHANGELOG.md and docs/index.md changed, so no src/ or js/ behaviour moved. The only references to docs/index.md left are in the profile and the CHANGELOG. Nothing is blocking.

Findings (most severe first; non-blocking)

  • ➖ .github/repo-docs.py, .github/profiles/*: these are "never edited" files. A wholesale refresh to canon is the tool's own output, not a hand edit, so this is acceptable. I could not compare the bytes with canon (documentation/repo-docs is outside this session's scope), and canon-stamp reports SKIP offline. Every app's vendored copy is still the older version, so this pilot is the first to carry the new canon. dani, please confirm it is the verbatim canon output.
  • ➖ CHANGELOG.md:16-17: under [Unreleased] › Added, the entry "The authority table in docs/index.md…" now contradicts the new Removed entry at CHANGELOG.md:29. No tag exists, so the file was added and removed within the same unreleased span. Dropping the Added line, or folding it into the Removed one, would keep the release notes honest.
  • ➖ CHANGELOG.md:22-23: "README §Install cites ADR-0001…" names a section that no longer exists. The citation now sits in Inicio rápido de desarrollo.
  • ➖ The org's reviewer code standards still say "English for … docs". ADR 0006's opt-in regime deliberately reverses that for README.md in marked repos, and the profile enforces the change (must_be_spanish). The standards text needs updating to match, but this PR is not where that happens.

Cross-check with pi
pi did not review this SHA (docs-only; no aps-pi check ran).

Gate: CI green: PHP tests ✅, JS tests ✅, docs check ✅. Local gate: python3 .github/repo-docs.py check . --offline → 0 errors, exit 0 (6 SKIPs that need auth or canon); node --test js/*.test.js → pass. make test was not run locally: there is no PHP change, and CI's PHP tests are green on this head.
Suggested squash title: docs: opt into the Spanish-docs regime (ADR 0006)


Generated by Claude Code

@ddespinoza
ddespinoza merged commit 0353518 into main Oct 18, 2026
3 checks passed
@ddespinoza
ddespinoza deleted the docs/spanish-docs-optin branch October 18, 2026 21:11
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