Skip to content

add: missing docs in config-reference#228

Merged
dreyfus92 merged 2 commits into
mainfrom
es-up-01
Feb 20, 2026
Merged

add: missing docs in config-reference#228
dreyfus92 merged 2 commits into
mainfrom
es-up-01

Conversation

@dreyfus92
Copy link
Copy Markdown
Member

@dreyfus92 dreyfus92 commented Feb 19, 2026

Description

  • What does this PR change? Give us a brief description.
    Adds missing docs in config-reference

Summary by CodeRabbit

  • Documentation
    • Reorganized Spanish StudioCMS configuration reference for clarity and accessibility.
    • Added new Spanish docs covering features configuration (robotsTXT, dashboard, auth, developer options) and locale settings (dateLocale, dateTimeFormat, i18n).
    • Removed several older Spanish config pages to consolidate and streamline the documentation set.

@dreyfus92 dreyfus92 requested a review from a team as a code owner February 19, 2026 23:14
@htg-1-studiocms-cloud
Copy link
Copy Markdown

htg-1-studiocms-cloud Bot commented Feb 19, 2026

Dokploy Preview Deployment

Name Status Preview Updated (UTC)
StudioCMS Docs ✅ Done Preview URL 2026-02-20T22:03:11.088Z

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 19, 2026

📝 Walkthrough

Walkthrough

Removed several Spanish StudioCMS config-reference pages and added two consolidated Spanish pages (features and locale); updated the config-reference index links accordingly.

Changes

Cohort / File(s) Summary
Removed Spanish docs
src/content/docs/es/config-reference/dashboard.mdx, src/content/docs/es/config-reference/default-frontend-config.mdx, src/content/docs/es/config-reference/image-service.mdx, src/content/docs/es/config-reference/included-integrations.mdx, src/content/docs/es/config-reference/overrides.mdx, src/content/docs/es/config-reference/sdk.mdx
Deleted six existing Spanish config-reference MDX files (documentation-only removals).
Added Spanish docs
src/content/docs/es/config-reference/features.mdx, src/content/docs/es/config-reference/locale.mdx
Added two new Spanish MDX pages consolidating configuration reference content (features and locale).
Index change
src/content/docs/es/config-reference/index.mdx
Minor edit to the config-reference index (link/update).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • Adammatthiesen

Poem

🐰
I hopped through files both old and new,
Tidied pages, made a clearer view.
Features gathered, locales sing,
A snug little doc — ready to spring!

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the primary change: adding missing documentation files in the config-reference directory, as evidenced by the new features.mdx and locale.mdx files.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch es-up-01

Tip

Issue Planner is now in beta. Read the docs and try it out! Share your feedback on Discord.


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 and usage tips.

@studiocms-no-reply
Copy link
Copy Markdown
Member

studiocms-no-reply commented Feb 19, 2026

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/config-reference/dashboard.mdx Localization removed, will be marked as missing.
es/config-reference/default-frontend-config.mdx Localization removed, will be marked as missing.
es/config-reference/features.mdx Localization added, will be marked as complete.
es/config-reference/image-service.mdx Localization removed, will be marked as missing.
es/config-reference/included-integrations.mdx Localization removed, will be marked as missing.
es/config-reference/index.mdx Localization changed, will be marked as complete.
es/config-reference/locale.mdx Localization added, will be marked as complete.
es/config-reference/overrides.mdx Localization removed, will be marked as missing.
es/config-reference/sdk.mdx Localization removed, will be marked as missing.
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.

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: 3

🧹 Nitpick comments (1)
src/content/docs/es/config-reference/features.mdx (1)

70-84: Add Type/Default bullets to the sdk section for consistency.

The sdk section lacks the Type and Default bullets that appear in all other top-level feature sections (robotsTXT, injectQuickActionsMenu, cacheConfig). This same gap exists in both the English and Spanish versions.

📄 Suggested addition for `sdk`
 `sdk` puede ser un booleano o un objeto que contiene la configuración de caché. Si es un booleano, por defecto se establece en `true` y se transforma en un objeto con la configuración de caché por defecto.

+- **Tipo:** `boolean` | `{ cacheConfig?: boolean | { lifetime?: string } }`
+- **Valor predeterminado:** `true`
+
 ### Uso
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@src/content/docs/es/config-reference/features.mdx` around lines 70 - 84, Add
the missing "Type" and "Default" bullet lines to the `sdk` feature docs under
the "## `sdk`" heading so it matches other top-level feature sections; update
both English and Spanish files where `## `sdk`` appears (the same block that
shows the usage with defineStudioCMSConfig and features: { sdk: {} }) to include
a "Type" bullet (e.g., "boolean | object") and a "Default" bullet (e.g., "true →
{} (default cache config)") consistent with the style used in `robotsTXT`,
`injectQuickActionsMenu`, and `cacheConfig`.
🤖 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/config-reference/features.mdx`:
- Around line 296-319: Update the `providers` description to mention both
`usernameAndPassword` and `usernameAndPasswordConfig` as configurable keys (the
text currently only names `usernameAndPassword` but the example shows
`usernameAndPasswordConfig`); edit the paragraph around `providers` so it lists
both keys and briefly notes that `usernameAndPassword` toggles the provider and
`usernameAndPasswordConfig` contains provider-specific options like
`allowUserRegistration`, keeping the existing code example unchanged.
- Line 164: Change the capitalised word "Favicon" to lowercase "favicon" in the
Spanish doc sentence that describes `faviconURL`; update the sentence that
currently reads "`faviconURL` permite al usuario sobreescribir la URL del
Favicon por defecto..." so it reads "... la URL del favicon por defecto..." to
match Spanish common noun capitalization and keep the code symbol `faviconURL`
unchanged.

In `@src/content/docs/es/config-reference/locale.mdx`:
- Around line 76-85: The MDX code block showing the studiocms.config.mjs example
(starting with ```ts and using defineStudioCMSConfig with
locale.i18n.defaultLocale) is missing its closing triple-backtick fence; add a
closing ``` after the final `})` to properly terminate the code block so the
page renders correctly.

---

Nitpick comments:
In `@src/content/docs/es/config-reference/features.mdx`:
- Around line 70-84: Add the missing "Type" and "Default" bullet lines to the
`sdk` feature docs under the "## `sdk`" heading so it matches other top-level
feature sections; update both English and Spanish files where `## `sdk`` appears
(the same block that shows the usage with defineStudioCMSConfig and features: {
sdk: {} }) to include a "Type" bullet (e.g., "boolean | object") and a "Default"
bullet (e.g., "true → {} (default cache config)") consistent with the style used
in `robotsTXT`, `injectQuickActionsMenu`, and `cacheConfig`.

Comment thread src/content/docs/es/config-reference/features.mdx Outdated
Comment thread src/content/docs/es/config-reference/features.mdx
Comment thread src/content/docs/es/config-reference/locale.mdx Outdated
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.

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Duplicate comments:
In `@src/content/docs/es/config-reference/features.mdx`:
- Around line 296-319: Update the prose for the `providers` section to mention
the companion config key `usernameAndPasswordConfig` used in `authConfig` (shown
in the example) so it matches the code sample; specifically, change the sentence
that currently only names `usernameAndPassword` to also reference
`usernameAndPasswordConfig` and its purpose (e.g., configuring
`allowUserRegistration`) so readers of `defineStudioCMSConfig` can see both keys
are configurable.

@dreyfus92 dreyfus92 merged commit f0af9cc into main Feb 20, 2026
8 checks passed
@dreyfus92 dreyfus92 deleted the es-up-01 branch February 20, 2026 23:51
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