Skip to content

docs: translate AUTHORING.md to Spanish - #139

Merged
ulises-jeremias merged 2 commits into
Create-Python-App:mainfrom
Ava-91:docs/spanish-authoring
Aug 3, 2026
Merged

docs: translate AUTHORING.md to Spanish#139
ulises-jeremias merged 2 commits into
Create-Python-App:mainfrom
Ava-91:docs/spanish-authoring

Conversation

@Ava-91

@Ava-91Ava-91 commented Aug 3, 2026

Copy link
Copy Markdown
Contributor

Adds a Spanish translation of the AUTHORING documentation to help Spanish-speaking contributors understand how templates and extensions work.

Changes:

  • Added docs/AUTHORING.es.md
  • Translated template directory structure documentation
  • Added Spanish documentation for cpa.config.json and Jinja variables
  • Documented extension structure and pyproject.toml merging
  • Added local testing and contributor checklists

Testing:
Documentation-only change. No code changes were made.

Summary by CodeRabbit

  • Documentation
    • Added a comprehensive Spanish-language guide for creating and maintaining templates and extensions.
    • Documented configuration, naming conventions, variables, quality requirements, testing workflows, compatibility, and generation order.
    • Included practical examples, checklists, and guidance for documentation and future AI/ML-related content.

@coderabbitai

coderabbitaiBot commented Aug 3, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@Ava-91, you've reached your PR review limit, so we couldn't start this review.

Next review available in:28 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 686e3cb1-4376-4979-a048-e56d2be39540

📥 Commits

Reviewing files that changed from the base of the PR and between d1e110c and 70f482f.

📒 Files selected for processing (1)
  • docs/AUTHORING.es.md
📝 Walkthrough

Walkthrough

Se añadió una guía completa en español para la autoría y el mantenimiento de plantillas y extensiones CPA. Incluye configuración, convenciones, compatibilidad, calidad, tipado, registro, generación y pruebas locales.

Changes

Guía de autoría en español

Layer / File(s)Summary
Documentación de autoría
docs/AUTHORING.es.md
La nueva guía documenta la estructura de proyectos, cpa.config.json, variables Jinja2, convenciones, extensiones, calidad, tipado, registro, compatibilidad, generación y pruebas locales.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related issues

  • Create-Python-App/cpa-templates issue 117: La documentación añadida implementa la guía de autoría en español y los detalles de pruebas locales solicitados.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ PassedThe title clearly and concisely describes the addition of the Spanish translation of AUTHORING.md.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/AUTHORING.es.md`:
- Around line 424-440: Corrige el flujo documentado alrededor de la generación
de `my-app`: establece `CI=true` y usa `--no-interactive` en lugar de depender
de `--yes`, entra en el directorio del proyecto generado antes de ejecutar las
validaciones y conserva allí los comandos `uv sync`, `uv run ruff check .` y `uv
run pytest`.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 76cd7ad7-7991-47ab-a993-0f88b4688b8e

📥 Commits

Reviewing files that changed from the base of the PR and between 39f2706 and d1e110c.

📒 Files selected for processing (1)
  • docs/AUTHORING.es.md

Comment threaddocs/AUTHORING.es.md

@ulises-jeremiasulises-jeremias left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review: ✅ Approve

Solid translation — the structure mirrors AUTHORING.md well and covers all the key concepts: template layout, cpa.config.json, Jinja2 variables, extensions, pyproject.toml deep-merge, naming conventions, quality bar, and local testing.

CI

All checks pass ✅. The second commit (70f482f) already fixed the local testing flow that CodeRabbit flagged (adding CI=true, --no-interactive, and cd my-app).

One thing to address before merge

Copy-paste reference to cna-templates in the header (line 3):

Guía para colaboradores que quieran añadir o actualizar plantillas y extensiones en `cpa-templates`. Referencia de compatibilidad: `cna-templates AUTHORING.md`.

The phrase Referencia de compatibilidad: cna-templates AUTHORING.md looks like a carry-over from the sister project cna-templates. In the context of this file, it's either:

  • A reference to the original English doc it was translated from — in which case it should say cpa-templates AUTHORING.md (or just AUTHORING.md), or
  • An intentional cross-project note — in which case it should be made explicit (e.g., "esta guía sigue la misma estructura que cna-templates/AUTHORING.md").

Either way, cna-templates AUTHORING.md as written is ambiguous and might confuse contributors who land on this file directly.

Minor observations (non-blocking)

  • The code fence on line ~55 uses ``` on one line and closes with ``` correctly — looks fine after the second commit.
  • The translation quality is good throughout. Technical terms like StrictUndefined, pyproject.toml, cpa.config.json, uv sync are correctly left untranslated, which is the right call.
  • The contributor checklists and examples are a nice addition that aren't in the English version.

Fix the cna-templates reference and this is merge-ready.


👋 Great first contribution! Come join our community Discord where Spanish-speaking contributors are always welcome: Join the Discord — quick questions, coordination, and translation discussions all happen there.

@ulises-jeremias
ulises-jeremias merged commit 29da9d1 into Create-Python-App:mainAug 3, 2026
13 checks passed
Sign up for freeto 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

@Ava-91@ulises-jeremias