i18n(es): update cli.mdx#109
Conversation
WalkthroughThe Spanish documentation for StudioCMS CLI tools was extensively revised and expanded. The update introduces a sidebar badge, a detailed table of contents, and reorganizes the CLI tool sections. The documentation now covers three main commands: Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI_Docs
User->>CLI_Docs: Access CLI documentation
CLI_Docs-->>User: Show sidebar badge and table of contents
User->>CLI_Docs: View 'studiocms' command details
CLI_Docs-->>User: Display commands, options, and usage
User->>CLI_Docs: View 'create-studiocms' command details
CLI_Docs-->>User: Display interactive options and flags
User->>CLI_Docs: View '@studiocms/upgrade' section
CLI_Docs-->>User: Show upgrade instructions and examples
User->>CLI_Docs: Follow reference to environment variables page
Possibly related PRs
Suggested labels
Suggested reviewers
Tip ⚡💬 Agentic Chat (Pro Plan, General Availability)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🔭 Outside diff range comments (1)
src/content/docs/es/how-it-works/cli.mdx (1)
119-124:⚠️ Potential issue
⚠️ Inconsistencia en el nombre del comandoget-turso.
El título de sección usaget-turso, la lista de comandos también, pero el bloque de uso muestragetTurso. Esto podría confundir al usuario. Unifica a uno de los dos formatos (recomiendo kebab-case:get-turso).Also applies to: 127-133
🧹 Nitpick comments (14)
src/content/docs/es/how-it-works/cli.mdx (14)
28-33: Recomendación: Usar resaltado de sintaxis más adecuado.
Se está usando ```log como fence, pero para comandos CLI y scripts de terminal es más habitualbasho `shell`. Esto mejorará la legibilidad y accesibilidad:-```log +```bash
35-39: Consistencia en la traducción de opciones de color.
Se usa "forzar salida de color" y "deshabilitar salida de color". Para mayor coherencia, sugiero "forzar salida en color" / "deshabilitar salida en color" y unificar mayúsculas iniciales en las descripciones.
41-47: Nitpick: Puntuación y mayúsculas en la lista de comandos.
- Algunas descripciones terminan con punto y otras no.
- "Agregar complemento(s) de StudioCMS a tu proyecto" podría simplificarse a "Agregar complementos a tu proyecto".
56-67: Unificar ejecución de scripts entre gestores de paquetes.
Para coherencia, podrías usarnpm run,pnpm runyyarn runo bien documentar por qué Yarn y pnpm no requierenrun. Ejemplo:- pnpm studiocms [comando] + pnpm run studiocms [comando]
71-85: Capitalización de "Uso" y formato de argumentos.
En la sección deaddusasuso:(minúscula) pero en otros lugaresUso:(mayúscula). Además, encerrar<plugins...>entre backticks garantiza que se destaque como código.
87-99: Ajuste de formato en seccióncrypto.
Revisa la jerarquía de títulos y asegúrate de que los bloques de código usen la misma convención de fence (bash/shell) y que los títulos “Opciones” y “Comandos” estén unificados con mayúsculas iniciales.
101-115: Mejorar legibilidad de opciones decrypto gen-jwt.
El alineado de descripciones de flags está poco uniforme. Podrías usar dos espacios para separar la bandera de la descripción o alinear manualmente las columnas para facilitar la lectura.
138-146: Verificar mayúsculas en descripciones deinit.
Por ejemplo,Modo de prueba(capital M) vshabilitar modo de depuración(minúscula h). Sugiero uniformizar todas las descripciones con mayúscula inicial.
161-161: Consistencia en título de enlace de variables de entorno.
El texto “Variables de Entorno” está en mayúsculas pero la ruta usa minúsculas. Para coherencia editorial, usa “variables de entorno” en minúsculas dentro del texto.🧰 Tools
🪛 LanguageTool
[typographical] ~161-~161: Mayúsculas y minúsculas recomendadas.
Context: ... entorno, consulta la [documentación de Variables de Entorno][environment-variables].</Re...(AI_ES_GGEC_REPLACEMENT_CASING_UPPERCASE)
190-193: Asegurar estilo uniforme en lista de comandos decreate-studiocms.
Al igual que constudiocms, revisa si el asteriscointeractive*debería ir entre backticks o cómo presentas el comando predeterminado para mantener consistencia.
200-212: Agregar versión en Yarn para paridad con npm.
En npm incluyes@latestpero en Yarn omites la versión. Podrías indicaryarn create studiocms@latestpara que los ejemplos sean paralelos.
217-231: Mejorar legibilidad de comandos con múltiples flags.
La línea de ejemplo con--templatey--project-namees muy larga. Considera usar saltos de línea o mostrar cada flag en una línea separada dentro del bloque de código.
237-237: Nitpick: Simplificar descripción de plantillas.
Podrías acortar la frase eliminando “por ejemplo” o mover el ejemplo a un bloque separado para reducir la longitud del párrafo principal.🧰 Tools
🪛 LanguageTool
[locale-violation] ~237-~237: Forma correcta si se usa voseo. Si no, utilice una forma alternativa.
Context: ..., disponibles en GitHub. Cuando se usa--template, la CLI busca las plantillas en el rep...(VOSEO)
[uncategorized] ~237-~237: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...astudiocms/basicsapunta al proyectobasicsdentro de la carpetastudiocms...(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~237-~237: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ... proyectobasicsdentro de la carpetastudiocmsen la raíz del repositorio. ### Desglo...(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
314-317: Aclaración en descripción de la opcióntag.
Podrías mencionar ejemplos de tags válidos (por ejemplo,beta,rc, etc.) para guiar al usuario y evitar confusiones.🧰 Tools
🪛 LanguageTool
[misspelling] ~316-~316: Posible error de ortografía.
Context: ...### tag (opcional) Es posible pasar untagespecífico para resolver paquetes. Si n...(APOSTROFO_ACENTO)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/es/how-it-works/cli.mdx(3 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/es/how-it-works/cli.mdx
[misspelling] ~18-18: El plural de las siglas no se marca gráficamente./components/ReadMore.astro'; Las CLIs de StudioCMS son utilidades que te perm...
Context: ...rom '
(SIGLAS)
[misspelling] ~20-~20: El plural de las siglas no se marca gráficamente.
Context: ...lidades útiles para StudioCMS. Hay dos CLIs diferentes que son parte del ecosistema...
(SIGLAS)
[uncategorized] ~152-~152: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...pciones para: - Usa una plantilla de .env de ejemplo - Usa el constructor inte...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~152-~152: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...- Usa una plantilla de .env de ejemplo - Usa el constructor interactivo de .env...
(AI_ES_GGEC_REPLACEMENT_OTHER)
[uncategorized] ~153-~153: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ... - Usa el constructor interactivo de .env que puede: - Configura una nu...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~156-~156: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ... de cifrado y otras variables requeridas - Omitir la creación del archivo de entorn...
(AI_ES_GGEC_REPLACEMENT_OTHER)
[typographical] ~161-~161: Mayúsculas y minúsculas recomendadas.
Context: ... entorno, consulta la [documentación de Variables de Entorno][environment-variables].</Re...
(AI_ES_GGEC_REPLACEMENT_CASING_UPPERCASE)
[typographical] ~215-~215: Mayúsculas y minúsculas recomendadas.
Context: ... create-studiocms se ejecuta automáticamente en modo _intera...
(AI_ES_GGEC_REPLACEMENT_CASING_LOWERCASE)
[typographical] ~235-~235: Símbolo desparejado: Parece que falta un ‘[’.
Context: ...em> [Consulta la lista completa][templates] de plantillas, disponibles e...
(ES_UNPAIRED_BRACKETS)
[locale-violation] ~237-~237: Forma correcta si se usa voseo. Si no, utilice una forma alternativa.
Context: ..., disponibles en GitHub. Cuando se usa --template, la CLI busca las plantillas en el rep...
(VOSEO)
[uncategorized] ~237-~237: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...a studiocms/basics apunta al proyecto basics dentro de la carpeta studiocms...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~237-~237: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ... proyecto basics dentro de la carpeta studiocms en la raíz del repositorio. ### Desglo...
(AI_ES_GGEC_REPLACEMENT_PUNCTUATION)
[uncategorized] ~272-~272: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ...ocumentación][turso-docs] de Turso. :::note Windows requiere el uso de WSL según Tur...
(AI_ES_GGEC_REPLACEMENT_OTHER)
[uncategorized] ~289-~289: Probablemente hay un error. Considere aplicar la sugerencia.
Context: ... actualizar tu proyecto oficial de Astro, integraciones al mismo tiempo que actua...
(AI_ES_GGEC_REPLACEMENT_OTHER)
[misspelling] ~316-~316: Posible error de ortografía.
Context: ...### tag (opcional) Es posible pasar un tag específico para resolver paquetes. Si n...
(APOSTROFO_ACENTO)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Run Starlight Link Check
🔇 Additional comments (4)
src/content/docs/es/how-it-works/cli.mdx (4)
7-12: Bien hecho: Metadatos de frontmatter actualizados con ToC y badge.
La inclusión del badge “Actualizado” y la configuración detableOfContentsmejoran la navegación y visibilidad de la fecha de actualización.
22-24: Verificar enlaces internos de la lista de CLI.
Asegúrate de que el ancla#studiocms-upgradecoincide con el ID generado para la sección@studiocms/upgrade. Podría ser necesario ajustar el texto del enlace o el slug de la sección para evitar enlaces rotos.
296-309: Ejemplos de uso de@studiocms-upgradeclaros.
Los comandos de npx, pnpm y yarn están bien presentados. Buen trabajo en mostrar las tres opciones.
321-333: Buena cobertura de ejemplos con tags.
La sección muestra correctamente cómo pasar un tag distinto para cada gestor de paquetes.
3 participants
Description
Updates cli.mdx
Summary by CodeRabbit
studiocms,create-studiocms, and the new@studiocms/upgradecommands, including usage examples and options.