Skip to content

docs: make the quickstart section link absolute - #6

Merged
ddespinoza merged 1 commit into
mainfrom
docs/quickstart-absolute-link
Oct 18, 2026
Merged

ddespinoza merged 1 commit into
mainfrom
docs/quickstart-absolute-link

Conversation

@ddespinoza

Copy link
Copy Markdown
Contributor

documentation/tools/gen-inicio-rapido.py includes this README's ## Inicio rápido de desarrollo section verbatim into the Sphinx site; the relative ADR link made the documentation build fail (myst cross-reference target not found). Same URL, absolute.

🤖 Generated with Claude Code

…ite includes it verbatim

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@ddespinoza
ddespinoza merged commit a894ebe into main Oct 18, 2026
3 checks passed

Copy link
Copy Markdown
Contributor Author

🤖 Claude review — ✅ Ready to merge

A one-line README change: the ADR 0001 link in ## Inicio rápido de desarrollo changes from relative to absolute, so a copy of that section included somewhere else (the Sphinx quickstart) can still resolve it. The new URL points to docs/adr/0001-committed-subtree-is-the-distribution.md on main, and that file exists there. I checked the rest of the section, and this was its only Markdown link, so no other relative link is left to break the include. The Spanish prose is unchanged, and no code, js/ or generated file is touched. A docs-only change needs no CHANGELOG.md entry.

Findings (most severe first; file:line; why it matters)

  • None blocking.
  • ➖ nit, not blocking: the PR doesn't have the ai-assisted label that the org CONTRIBUTING asks AI-made PRs to carry. The disclosure line is there.

Cross-check with pi
pi did not review this SHA. It skips docs-only PRs, and no aps-pi check ran.

Gate: CI: check (docs) ✅, JS tests ✅, PHP tests still running when I posted this (the diff touches only README.md, so it can't affect PHPUnit). Local: python3 .github/repo-docs.py check . --offline → 0 errors; node --test js/*.test.js → 2 pass, 0 fail. I did not run make test locally.
Suggested squash title: docs(readme): make the quickstart ADR link absolute


Generated by Claude Code

@ddespinoza
ddespinoza deleted the docs/quickstart-absolute-link branch October 18, 2026 21:39
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