i18n(es): translate studiocms-markdoc, studiocms-mdx , and rendering.mdx documentation files#28
Conversation
…ring.mdx` documentation files
WalkthroughThis pull request introduces three new Markdown documentation files for StudioCMS. Two files under the plugins section detail the integration and configuration for the Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant R as Router
participant S as StudioCMS SDK
participant L as Layout Component
U->>R: Request page (with slug)
R->>S: Fetch page data using slug
alt Page exists
S-->>R: Return page data
R->>L: Render page with StudioCMSRenderer
L-->>U: Display rendered content
else Page not found
S-->>R: No page found
R->>U: Redirect to 404 page
end
Suggested labels
Suggested reviewers
Poem
🪧 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: 0
🧹 Nitpick comments (5)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (2)
1-11: Frontmatter Metadata and i18n Settings
The YAML frontmatter is well-structured and correctly enables internationalization withi18nReady: true. One small suggestion: consider whether the anglicism “Plugin” used in the sidebar badge (line 9) should be replaced with a fully Spanish term (e.g. “Complemento”) for consistency in a localized document.
16-19: Introduction Text Tone
The introduction text clearly explains the purpose of the MarkDoc integration. For a more consistent and formal presentation, consider replacing “plugin” with “complemento” if that fits your style guidelines.🧰 Tools
🪛 LanguageTool
[style] ~18-~18: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ight/components'; # Introducción Este plugin habilita el soporte de MarkDoc dentro d...(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-mdx.mdx (2)
1-11: Frontmatter Metadata and Localization
The frontmatter correctly marks the document as ready for i18n and contains clear metadata. Similar to the MarkDoc file, consider if the anglicism “Plugin” in the sidebar badge (line 9) should be localized to “Complemento” to maintain consistent language style.
16-19: Introduction and Description Clarity
The introduction succinctly states that the MDX integration is enabled for StudioCMS. As with the previous file, consider adopting a more formal localized term (e.g. “complemento”) for “plugin” if consistency with documentation style is desired.🧰 Tools
🪛 LanguageTool
[style] ~18-~18: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ight/components'; # Introducción Este plugin habilita el soporte de MDX dentro de St...(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
src/content/docs/es/utils/rendering.mdx (1)
9-12: Explanatory Text and Style Considerations
The descriptive text (especially around line 11) provides a good overview of how the rendering system works in StudioCMS. However, consider:
- Punctuation: There may be an opportunity to improve readability by adding a comma in complex sentences where appropriate.
- Anglicisms: Terms like “Layout” and “plugin de constructor de páginas (pageBuilder)” are used; while “Layout” is a component name and may be kept as is, you might review “plugin” for a more formal Spanish alternative if desired.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~11-~11: Probablemente falta una coma.
Context: ...ión de la página, y envolviéndolo en un Layout como lo hacemos con el plugin `@studioc...(AI_ES_HYDRA_LEO_MISSING_COMMA)
[style] ~11-~11: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...olo en un Layout como lo hacemos con el plugin@studiocms/blog. Por ejemplo, un plug...(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
[style] ~11-~11: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ugin@studiocms/blog. Por ejemplo, un plugin de constructor de páginas (pageBuilder)...(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-markdoc.mdx(1 hunks)src/content/docs/es/package-catalog/studiocms-plugins/studiocms-mdx.mdx(1 hunks)src/content/docs/es/utils/rendering.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/es/utils/rendering.mdx
[uncategorized] ~11-~11: Probablemente falta una coma.
Context: ...ión de la página, y envolviéndolo en un Layout como lo hacemos con el plugin `@studioc...
(AI_ES_HYDRA_LEO_MISSING_COMMA)
[style] ~11-~11: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...olo en un Layout como lo hacemos con el plugin @studiocms/blog. Por ejemplo, un plug...
(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
[style] ~11-~11: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ugin @studiocms/blog. Por ejemplo, un plugin de constructor de páginas (pageBuilder)...
(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-markdoc.mdx
[style] ~18-~18: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ight/components'; # Introducción Este plugin habilita el soporte de MarkDoc dentro d...
(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-mdx.mdx
[style] ~18-~18: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ight/components'; # Introducción Este plugin habilita el soporte de MDX dentro de St...
(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGIN)
🔇 Additional comments (6)
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-markdoc.mdx (2)
13-15: Import Statements Clarity
The import statements are clear and use proper package references. There are no issues with these lines.
20-37: Installation Instructions and Configuration Example
The installation steps are presented in a clear, step-by-step manner. The embedded configuration snippet (lines 28–37) is well-formatted, demonstrating how to import and use the plugin within the Astro configuration file. No changes required here.src/content/docs/es/package-catalog/studiocms-plugins/studiocms-mdx.mdx (2)
13-15: Import Statements Validity
The imports forPackageManagersand UI components are accurate and well-organized.
20-37: Installation Steps and Code Example
The instructions for installing the MDX package are detailed and the configuration code block (lines 28–37) clearly demonstrates the integration process. Everything looks accurate and easy to follow.src/content/docs/es/utils/rendering.mdx (2)
1-7: YAML Frontmatter for Rendering Document
The frontmatter is complete and sets a clear title and description for the rendering system documentation. No issues noted here.
13-39: Astro Code Snippet for Dynamic Routing and Rendering
The Astro component code block is clear and follows best practices:
- It correctly extracts and defaults the
slugparameter.- The use of
studioCMS_SDK.GET.databaseEntry.pages.bySlug(slug)properly retrieves the page data.- The redirection to a 404 page when the page is not found is handled logically.
- The Layout component wraps the content appropriately, and
StudioCMSRendererreceives the page data without issues.
Everything is well-implemented.
3 participants
Description
Translates missing files to spanish 🫡
Summary by CodeRabbit