docs(i18n): add Spanish README and Quickstart - #3673
Open
Marc Mayol Orell (marcmayol) wants to merge 1 commit into
Open
docs(i18n): add Spanish README and Quickstart#3673Marc Mayol Orell (marcmayol) wants to merge 1 commit into
Marc Mayol Orell (marcmayol) wants to merge 1 commit into
Conversation
Spanish was listed under "Wanted languages" in docs/i18n/README.md. This adds the two translated entry points and wires them into the language switchers, following the process documented in that file. - docs/i18n/README.es.md, translated from the root README.md - docs/i18n/quickstart.es.md, translated from docs/quickstart.md - Switcher entries in README.md, mkdocs.yml, and docs/i18n/README.md Product names, package names, commands, and API identifiers stay in English. Headings, code blocks, and admonitions are unchanged, and relative links are rewritten for the docs/i18n/ location. The spell-check workflow runs cspell with an English-only dictionary over added lines, and unlike the CJK translations a Latin-script one trips it on every word. The two translated files are therefore wrapped in cspell:disable/enable, and "Español" is added to the repo terms for the three switcher entries that live outside them. Signed-off-by: Marc Mayol Orell <marcmayolorell@gmail.com>
Marc Mayol Orell (marcmayol)
requested review from
MohammadHaroonAbuomar and
liamcrumm
as code owners
August 10, 2026 20:37
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
|
Welcome to the Agent Governance Toolkit! Thanks for your first pull request. |
|
🟡 Contributor Check: MEDIUM
Automated check by AGT Contributor Check. |
PR Review Summary
Verdict: AI review comments are untrusted advisory output. The summary reports workflow-generated completion status only, not model-authored pass/fail claims. |
Author
|
@microsoft-github-policy-service agree |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
None.
docs/i18n/README.mdlists Spanish under "Wanted languages", so the sections below are filled in.Problem & Solution
Problem:
docs/i18n/ships four translated entry points (ja, ko, zh-CN, zh-TW) and its own contribution guide names Spanish first in "Wanted languages", but no Spanish translation exists. Spanish-speaking readers land on an English-only README and Quickstart.Solution: Add the two Spanish entry points and wire them into the existing switchers, following the five steps in
docs/i18n/README.md:docs/i18n/README.es.mdREADME.md.docs/i18n/quickstart.es.mddocs/quickstart.md.docs/i18n/README.mdmkdocs.ymlesentry in the header language switcher.README.md.cspell-repo-terms.txtEspañol(see Spell-check note below).Translation conventions followed: product names, package names, commands, CLI flags, and API identifiers stay in English; headings, code blocks, tables, badges, and admonitions keep their structure; relative links are rewritten for the
docs/i18n/location, using absolute GitHub URLs for targets outsidedocs/, matching whatREADME.ko.mddoes.Spell-check note (worth a maintainer's opinion)
spell-check.ymlruns cspell with an English-only dictionary over added lines, collected into a single file, soignorePathscannot scope it. The CJK translations pass because cspell does not tokenize those scripts — a Latin-script translation trips on every word (911 findings on this diff).The two translated files are therefore wrapped in
cspell:disable/cspell:enable, which brings the job back to 0 findings.Españolgoes into the repo terms because it appears in three switcher entries outside those files.This is the smallest fix, but it is not the only one, and the same wall will hit French, German, and Portuguese. If you would rather solve it once, I am happy to switch this PR to either: adding
@cspell/dict-es-esto the workflow install and importing it in.cspell.json, or teachingscripts/ci/changed_lines.pyan--excludepathspec sodocs/i18n/is skipped for spell-check. Say which you prefer.Impact on Your Work
I read the toolkit's docs in Spanish-language contexts and wanted the Quickstart usable without translating it in my head each time. Since the repo already asks for Spanish, contributing it back was more useful than keeping a local copy.
Timeline
None.
Alternatives Considered
docs/. Rejected: the established pattern is two entry points per language, and a larger surface is harder to keep in sync. README and Quickstart match what ja/ko/zh ship.mkdocs.ymlanddocs/i18n/README.mdbut missing from the root README's 🌍 line). Left out to keep this PR to one language; flagging it here as a separate small fix.Type of Change
Package(s) Affected
Shared / other:
Testing
Unit Testing
N/A — no code changes. No tests were added; the repo's docs tooling tests (
scripts/tests/test_docs_check_*.py) already cover the checkers that validate these files.Manual Testing
Run locally against this branch:
python scripts/docs/check_links.py --root .→294 files, 2709 links, 0 new broken. Verified the checker actually covers the new file by temporarily breaking a link in it and confirming it was reported.python scripts/docs/check_frontmatter.py --root . --strict→ the only finding is pre-existing onmain(docs/security/audits/2026-07-31-fail-open-closure-python-reference.md, missing frontmatter) and is untouched by this PR.spell-check.ymlend to end:scripts/ci/changed_lines.py→cspell@8.17.3 --config .cspell.json→ exit 0.mkdocs.ymlparses;extra.alternateresolves toen, es, ja, ko, zh-Hans, zh-Hant.#inicio-rápido,#especificaciones) match the translated headings.Checklist
Attribution & Prior Art
Prior art / related projects (if any):
None. The structure follows this repo's own
README.ko.mdandREADME.ja.md.AI Assistance
If AI tools materially shaped this change, briefly note what was used:
An AI coding assistant produced the first draft of the translation and ran the CI checks listed above. I have read the translated text end to end and reviewed every change before submitting; all output was verified by me.
IP, Patents, and Licensing