i18n(es): update more outdated docs#223
Conversation
Dokploy Preview Deployment
|
📝 WalkthroughWalkthroughSpanish documentation updates: SDK docs rewritten to an Effect-based SDKCore/SDKCoreJs/runSDK pattern; REST API doc minor cleanup; package catalog reorganized to add a "Manejadores de Almacenamiento" section; plugin pages (blog, devapps) expanded with options, routes, and updated examples. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
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
|
There was a problem hiding this comment.
Actionable comments posted: 7
🧹 Nitpick comments (1)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-devapps.mdx (1)
73-73: Heading capitalization inconsistent with line 57.
### Opciones de Configuracióncapitalizes "Configuración" but the sibling heading on line 57 (### Ejemplo de configuración) does not. In Spanish, only the first word (and proper nouns) are capitalized in headings.✏️ Proposed fix
-### Opciones de Configuración +### Opciones de configuración🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-devapps.mdx` at line 73, The heading "### Opciones de Configuración" uses title case while the sibling "### Ejemplo de configuración" uses sentence case; change the former to sentence case by lowercasing "Configuración" so the heading reads "### Opciones de configuración" to match the style used by the existing heading.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/es/how-it-works/sdk.mdx`:
- Line 13: Replace the untranslated Markdown heading "## Basic Usage" with its
Spanish equivalent "## Uso básico" in the file (update the exact heading string
`## Basic Usage` to `## Uso básico`) so the document is fully localized; ensure
you preserve the Markdown heading level and spacing.
- Around line 36-37: The comment uses the wrong casing for the SDK identifier —
it says "SDKCoreJS" while the code uses "SDKCoreJs"; update the comment text to
match the actual identifier name SDKCoreJs so documentation and code are
consistent (search for the comment near usage of runSDK and SDKCoreJs and change
the comment string accordingly).
- Around line 28-29: The code example inside the Effect.gen callback has
inconsistent indentation (1-space) for the lines " // luego haz algo con el SDK"
and "return yield* sdk.GET.pages()"; update those lines to use 2-space
indentation to match the surrounding block and maintain consistent formatting
within the Effect.gen callback (look for the Effect.gen(...) callback and the
sdk.GET.pages() call to locate the snippet).
- Around line 70-74: The Spanish doc references nonexistent pages
(/es/ecosystem/packages/sdk and /es/ecosystem/packages/kysely) inside the
ReadMore block; either add Spanish translations for the missing package pages
(create equivalents of the English SDK and Kysely package MDX files) and keep
the links as-is, or update the two hrefs to point to an existing resource (e.g.,
the English or French package pages or a generic /es/ecosystem index) so links
don't 404. Locate the ReadMore usage that contains `/es/ecosystem/packages/sdk`
and `/es/ecosystem/packages/kysely` and change the target URLs or add the
translated MDX files accordingly.
In `@src/content/docs/es/package-catalog/index.mdx`:
- Line 14: Add a comma after the inline Badge component so the subordinate
clause is correctly separated from the main clause; locate the sentence
containing the <Badge text="Experimental" variant="danger" /> component in
src/content/docs/es/package-catalog/index.mdx and insert a comma immediately
after the component so the text reads "...<Badge ... />, lo que significa
que..." to fix the missing comma.
In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx`:
- Line 13: Add a comma before "así como" in the sentence that begins "Este
complemento habilita las características del Blog de StudioCMS así como un
frontend..." so it reads "...las características del Blog de StudioCMS, así como
un frontend..."; update the string containing that sentence in the document
(search for the exact phrase "Este complemento habilita las características del
Blog de StudioCMS así como un frontend") to insert the comma.
- Line 103: Replace the nonstandard Spanish JSDoc tag "@ejemplo" with the
canonical English "@example" in the JSDoc block (the line containing "* `@ejemplo`
'/noticias'") so tooling (IDE hover, typedoc) recognizes the example; update any
other translated JSDoc tags in the same block to their English equivalents to
ensure consistent tooling support.
---
Nitpick comments:
In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-devapps.mdx`:
- Line 73: The heading "### Opciones de Configuración" uses title case while the
sibling "### Ejemplo de configuración" uses sentence case; change the former to
sentence case by lowercasing "Configuración" so the heading reads "### Opciones
de configuración" to match the style used by the existing heading.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx (1)
52-112: Mixed tab/space indentation in the TypeScript code block.Throughout the
StudioCMSBlogOptionstype definition, JSDoc comment lines use tab indentation while property declaration lines use 2-space indentation. This renders inconsistently.✏️ Proposed fix (normalize to spaces throughout)
- /** - * Lenguaje HTML por defecto - El lenguaje por defecto para la etiqueta HTML - * `@default` 'en' - */ + /** + * Lenguaje HTML por defecto - El lenguaje por defecto para la etiqueta HTML + * `@default` 'en' + */ htmlDefaultLanguage: string | undefined;Apply the same 2-space normalization to all JSDoc blocks in the type definition.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx` around lines 52 - 112, The JSDoc comments in the StudioCMSBlogOptions type use tab indentation while the property lines use 2-space indentation; normalize all indentation to 2 spaces for consistency by replacing leading tab characters in the JSDoc/comment lines inside the StudioCMSBlogOptions definition (including comments for htmlDefaultLanguage, htmlDefaultHead, favicon, sitemap, injectRoutes and blog and its nested fields title, enableRSS, route) with two spaces so the comments align with the property declarations.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/es/how-it-works/sdk.mdx`:
- Line 17: The displayed code-block section labels are in English; update the
twoslash annotations in the `example.ts` code fence so the visible labels are
localized to Spanish by replacing the two annotation strings `{"Working with
StudioCMS SDK and Effect":4}` and `{"Working with StudioCMS SDK without
Effect":16}` with Spanish equivalents (e.g. `{"Trabajando con el SDK de
StudioCMS y Effect":4}` and `{"Trabajando con el SDK de StudioCMS sin
Effect":16}`) so the rendered labels in the code block within
src/content/docs/es/how-it-works/sdk.mdx appear translated.
In `@src/content/docs/es/package-catalog/index.mdx`:
- Line 18: Update the Spanish headings to follow RAE capitalization: change the
heading text "Manejadores de Almacenamiento" to "Manejadores de almacenamiento"
and change the single-word heading "Comunidad" to "comunidad" in
src/content/docs/es/package-catalog/index.mdx so only the first word and proper
nouns are capitalized (use the exact heading strings to locate and replace).
---
Duplicate comments:
In `@src/content/docs/es/how-it-works/sdk.mdx`:
- Around line 28-29: The two lines inside the Effect.gen callback (the comment
"// luego haz algo con el SDK" and the "return yield* sdk.GET.pages()"
statement) use 1-space indentation while the surrounding block uses 2 spaces;
update those lines to match the surrounding 2-space indentation so the
`Effect.gen` callback body is consistently indented and aligned with adjacent
lines (adjust the indentation for the comment and the call to sdk.GET.pages()).
- Line 13: The heading "## Basic Usage" in the Spanish doc should be translated
and has been changed to "## Uso básico"; verify the translated heading appears
in src/content/docs/es/how-it-works/sdk.mdx and remove any remaining instances
of the original English heading or duplicate headings (search for "## Basic
Usage" and "## Uso básico") so only the Spanish version remains and the document
renders correctly.
- Around line 36-37: The inline comment/text uses "SDKCoreJS" but the actual
identifier in code is "SDKCoreJs"; update the documentation line to use the
exact identifier "SDKCoreJs" (or, if you prefer to change the code, rename the
symbol to "SDKCoreJS" everywhere) so the casing matches; locate the snippet
referencing runSDK and SDKCoreJs (the line with runSDK(SDKCoreJs.GET.pages()))
and correct the comment/text to "SDKCoreJs".
- Around line 70-73: The Spanish page references non-existent ecosystem pages;
update the two links inside the ReadMore block that point to
/es/ecosystem/packages/sdk and /es/ecosystem/packages/kysely (look for the "##
Lectura adicional" section and the <ReadMore> block) to valid targets — either
change them to the existing English or French equivalents (e.g.,
/ecosystem/packages/sdk or the French paths) or remove/replace with working
Spanish pages or a note linking to the English versions; ensure the displayed
text remains Spanish and that the updated hrefs do not 404.
In `@src/content/docs/es/package-catalog/index.mdx`:
- Line 14: The sentence containing the Badge component "<Badge
text=\"Experimental\" variant=\"danger\" />" now correctly includes the comma
before "lo que significa"; no code change is needed for the text itself—please
mark the review as approved and remove the duplicate review comment
([duplicate_comment]) from the PR to avoid noise.
In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx`:
- Line 16: The comma is misplaced in the sentence containing "así como, un
frontend": move the comma so it appears before "así como" and remove the comma
after it, producing "habilita las características del Blog de StudioCMS, así
como un frontend en tu proyecto Astro" (locate the sentence with the phrase "así
como, un frontend" to update).
- Line 16: The documentation originally used the nonstandard tag `@ejemplo`;
update the tag to the standard `@example` (as already done) and ensure all other
occurrences of `@ejemplo` in this document are replaced with `@example`; verify
any example blocks associated with the tag (the `@example` annotations and
surrounding code fences in studiocms-blog.mdx) still render correctly in the MDX
build after the change.
---
Nitpick comments:
In `@src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx`:
- Around line 52-112: The JSDoc comments in the StudioCMSBlogOptions type use
tab indentation while the property lines use 2-space indentation; normalize all
indentation to 2 spaces for consistency by replacing leading tab characters in
the JSDoc/comment lines inside the StudioCMSBlogOptions definition (including
comments for htmlDefaultLanguage, htmlDefaultHead, favicon, sitemap,
injectRoutes and blog and its nested fields title, enableRSS, route) with two
spaces so the comments align with the property declarations.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/content/docs/es/package-catalog/index.mdx (1)
18-22: Consider adding---separator for structural consistency.The two existing h3 sections ("Complementos de StudioCMS" and "Complementos de la Comunidad") each have a
---thematic break immediately after the heading (lines 23 and 28), but the new "Manejadores de almacenamiento" section omits it.✏️ Proposed fix
### Manejadores de almacenamiento +--- <PackageCatalog catalog="storage-managers" />🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/content/docs/es/package-catalog/index.mdx` around lines 18 - 22, Add the missing thematic break after the "Manejadores de almacenamiento" heading to match the file's sectional pattern: insert a '---' line immediately following the h3 heading that contains <PackageCatalog catalog="storage-managers" /> so it mirrors the existing structure used after the "Complementos de StudioCMS" and "Complementos de la Comunidad" headings.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/content/docs/es/package-catalog/index.mdx`:
- Line 16: The heading "## Catálogos de Paquetes" uses incorrect capitalization
for Spanish per RAE; change the heading text to "## Catálogos de paquetes"
(lowercase 'paquetes') in the file where the heading appears so it satisfies the
linter and style rules; locate the exact heading string "## Catálogos de
Paquetes" and edit it to "## Catálogos de paquetes".
---
Duplicate comments:
In `@src/content/docs/es/how-it-works/sdk.mdx`:
- Around line 28-29: Indentation in the Effect.gen callback is inconsistent:
align the two lines that call into the SDK to match the 2-space indentation used
by the line declaring SDKCore (const sdk = yield* SDKCore;). Locate the
Effect.gen callback containing "const sdk = yield* SDKCore;" and change the
lines " // luego haz algo con el SDK" and "return yield* sdk.GET.pages()" to use
the same 2-space indent as the SDKCore line so the callback block has consistent
indentation.
- Around line 36-37: The comment uses the wrong casing for the identifier:
change "SDKCoreJS" in the inline comment to match the actual symbol "SDKCoreJs"
used in the code (referenced by runSDK(SDKCoreJs.GET.pages())); update the
comment text so the identifier casing is consistent with SDKCoreJs.
- Around line 70-74: The Spanish page contains broken links to
`/es/ecosystem/packages/sdk` and `/es/ecosystem/packages/kysely`; update the
hrefs inside the ReadMore block in this file (`ReadMore` usage around the
"Lectura adicional" section) to point to valid pages (e.g., remove the `/es`
prefix to use `/ecosystem/packages/sdk` and `/ecosystem/packages/kysely` or
replace with the correct Spanish translations if those pages exist), ensuring
the anchor paths reference existing routes so they no longer 404.
In `@src/content/docs/es/package-catalog/index.mdx`:
- Line 27: The Spanish heading "Complementos de la Comunidad" should use
lowercase per RAE; update the heading string in this file from "Complementos de
la Comunidad" to "Complementos de la comunidad" (locate the Markdown/MDX heading
line containing that exact text and edit it).
---
Nitpick comments:
In `@src/content/docs/es/package-catalog/index.mdx`:
- Around line 18-22: Add the missing thematic break after the "Manejadores de
almacenamiento" heading to match the file's sectional pattern: insert a '---'
line immediately following the h3 heading that contains <PackageCatalog
catalog="storage-managers" /> so it mirrors the existing structure used after
the "Complementos de StudioCMS" and "Complementos de la Comunidad" headings.
Description
Updates more stale docs
Summary by CodeRabbit