Skip to content

i18n(es): update multiple files pt. 2#30

Merged
dreyfus92 merged 2 commits into
mainfrom
es-06
Mar 31, 2025
Merged

i18n(es): update multiple files pt. 2#30
dreyfus92 merged 2 commits into
mainfrom
es-06

Conversation

@dreyfus92
Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 commented Mar 30, 2025

Description

  • What does this PR change? Give us a brief description.
    update multiple files pt. 2

Summary by CodeRabbit

  • Documentation
    • Updated the "Cómo funciona" reference in our guide by replacing the direct URL with a centralized markdown link for improved clarity and easier maintenance.
    • Added a new endpoint description for user details in the REST API documentation.
    • Enhanced formatting in the community plugins documentation with a blank line for better readability.
    • Updated the syntax highlighting for code blocks in the StudioCMS blog plugin documentation.
    • Revised the StudioCMSPlugin type definition, introducing new properties for better configuration and navigation link management.

@dreyfus92 dreyfus92 requested a review from a team as a code owner March 30, 2025 21:27
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Mar 30, 2025

Walkthrough

This pull request updates several Spanish documentation files. It replaces a direct URL hyperlink with a markdown reference in getting-started.mdx, adds a new endpoint description in restapi.mdx, and makes minor formatting adjustments in other files. Additionally, it modifies the StudioCMSPlugin type definition by removing and adding properties for better clarity and functionality. The overall structure and content of the documents remain largely unchanged.

Changes

File(s) Change Summary
src/content/docs/es/contributing/getting-started.mdx Replaced the direct URL /es/how-it-works/ with the markdown link [Cómo funciona][how-it-works] and added the [how-it-works] link definition.
src/content/docs/es/how-it-works/restapi.mdx Added a new line describing an endpoint for user details in the REST API documentation.
src/content/docs/es/package-catalog/community-plugins/web-vitals.mdx Added a blank line for formatting after a commented-out section.
src/content/docs/es/package-catalog/index.mdx Added a newline character at the end of the file.
src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx Changed code block syntax highlighting from ts to twoslash.
src/content/docs/es/plugins/index.mdx Modified StudioCMSPlugin type definition: removed onSave, added endpoint, frontendNavigationLinks, updated pageContentComponent, added rendererComponent and apiEndpoint.

Possibly related PRs

  • i18n(es): more updates #29: The changes in the main PR and the retrieved PR both involve modifying hyperlink references in markdown documents, specifically replacing direct URLs with reference-style links, indicating a strong connection at the code level.

Suggested reviewers

  • Adammatthiesen

Poem

I'm a code rabbit, hopping with delight,
Skipping direct links for references so bright.
Markdown magic now leads the way,
In docs where links softly sway.
A carrot cheer for every change in sight!


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Mar 30, 2025

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
es/contributing/getting-started.mdx Localization changed, will be marked as complete.
es/how-it-works/restapi.mdx Localization changed, will be marked as complete.
es/package-catalog/community-plugins/web-vitals.mdx Localization changed, will be marked as complete.
es/package-catalog/index.mdx Localization changed, will be marked as complete.
es/package-catalog/studiocms-plugins/studiocms-blog.mdx Localization changed, will be marked as complete.
es/plugins/index.mdx Localization changed, will be marked as complete.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

@dreyfus92 dreyfus92 marked this pull request as draft March 30, 2025 21:27
@dreyfus92 dreyfus92 marked this pull request as ready for review March 30, 2025 23:18
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (3)
src/content/docs/es/how-it-works/restapi.mdx (1)

43-43: Clarify the newly added content at line 43.
A new change has been introduced at line 43; however, it currently appears as a blank line or an incomplete endpoint description. Please verify that the intended new endpoint—describing details of a specific usuario in StudioCMS—is fully documented. If additional text was expected here, consider adding the appropriate descriptive content.

src/content/docs/es/plugins/index.mdx (2)

142-147: Update documentation for the endpoint property.
The comment block still states that the configuration endpoint should export an APIRoute named onSave. Since this property is now defined as a string (endpoint: string), please update the documentation comment to reflect its current usage.


294-298: Refine the ReadMore component usage and markdown link formatting.
Consider replacing the anglicism "ReadMore" with a Spanish equivalent (e.g., "Leer más") to maintain language consistency throughout the documentation. Additionally, verify that the markdown link [Haciendo Plugins Útiles][reference-page] is correctly formatted—static analysis suggests a possible unpaired bracket issue.

🧰 Tools
🪛 LanguageTool

[style] ~294-~294: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ra más información sobre la creación de plugins, consulta la Guía [Haciendo Plugins Úti...

(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGINS)


[typographical] ~294-~294: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...a creación de plugins, consulta la Guía [Haciendo Plugins Útiles][reference-page]...

(ES_UNPAIRED_BRACKETS)


[style] ~294-~294: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ... de plugins, consulta la Guía [Haciendo Plugins Útiles][reference-page] {/*...

(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGINS)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between bd4dc5a and d4416e4.

📒 Files selected for processing (5)
  • src/content/docs/es/how-it-works/restapi.mdx (1 hunks)
  • src/content/docs/es/package-catalog/community-plugins/web-vitals.mdx (1 hunks)
  • src/content/docs/es/package-catalog/index.mdx (1 hunks)
  • src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx (1 hunks)
  • src/content/docs/es/plugins/index.mdx (4 hunks)
✅ Files skipped from review due to trivial changes (3)
  • src/content/docs/es/package-catalog/community-plugins/web-vitals.mdx
  • src/content/docs/es/package-catalog/studiocms-plugins/studiocms-blog.mdx
  • src/content/docs/es/package-catalog/index.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/es/plugins/index.mdx

[style] ~294-~294: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ...ra más información sobre la creación de plugins, consulta la Guía [Haciendo Plugins Úti...

(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGINS)


[typographical] ~294-~294: Símbolo desparejado: Parece que falta un ‘]’.
Context: ...a creación de plugins, consulta la Guía [Haciendo Plugins Útiles][reference-page]...

(ES_UNPAIRED_BRACKETS)


[style] ~294-~294: Considere alternativas para este anglicismo (recomendable sobre todo en contextos más formales).
Context: ... de plugins, consulta la Guía [Haciendo Plugins Útiles][reference-page] {/*...

(ES_SIMPLE_REPLACE_ANGLICISM_PREMIUM_PLUGINS)

🔇 Additional comments (4)
src/content/docs/es/plugins/index.mdx (4)

149-155: Addition of frontendNavigationLinks property.
The new frontendNavigationLinks property is clearly defined and well-documented. Ensure that any examples or usage instructions elsewhere in the documentation align with this addition.


205-205: Type refinement for pageContentComponent.
Restricting the pageContentComponent property's type to 'studiocms/markdown' | 'studiocms/html' | string is a good improvement for clarity and type safety.


207-213: Addition of rendererComponent property.
The new rendererComponent property is clearly introduced with helpful documentation and examples on acceptable values. This change is consistent with the update to pageContentComponent.


219-249: Introduction of apiEndpoint property.
The detailed comment and example provided for the new apiEndpoint property effectively explain its usage for operations such as creating, editing, or deleting pages. This addition should help users correctly integrate API endpoints with their page types.

@dreyfus92 dreyfus92 merged commit dd1f6a4 into main Mar 31, 2025
@dreyfus92 dreyfus92 deleted the es-06 branch March 31, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants