i18n(fr): add config-reference/dashboard.mdx#25
Conversation
WalkthroughA new documentation file has been added to the French documentation for StudioCMS. This file details the configuration options available for the dashboard, including settings for enabling the dashboard, route overrides, developer-specific configurations, favicon settings, 404 route injection, version checking, and authentication. The document employs YAML front matter to provide metadata such as title, description, and sidebar order. Changes
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 (1)
src/content/docs/fr/config-reference/dashboard.mdx (1)
9-9: Import Statement & Typographic Consistency
The import statement on line 9 is correct. Note that the static analysis hint mentioned a potential issue with French typographic spacing (une espace fine insécable) before the semicolon. Verify that your code style guidelines either allow or require adjusting the spacing in this context.🧰 Tools
🪛 LanguageTool
[uncategorized] ~9-
9: Le point-virgule est précédé d’une espace fine insécable./components/ReadMore.astro'; Référence du schéma des options de con...
Context: ...adMore from '(FRENCH_WHITESPACE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/fr/config-reference/dashboard.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/fr/config-reference/dashboard.mdx
[uncategorized] ~9-9: Le point-virgule est précédé d’une espace fine insécable./components/ReadMore.astro'; Référence du schéma des options de con...
Context: ...adMore from '
(FRENCH_WHITESPACE)
🔇 Additional comments (13)
src/content/docs/fr/config-reference/dashboard.mdx (13)
1-7: YAML Front Matter is Well-Structured
The YAML section (lines 1–7) is properly formatted and clearly defines metadata (language readiness, title, description, sidebar order).
13-27: Configuration Code Block is Clear and Comprehensive
The embedded code example (lines 13–27) effectively shows how to usedefineStudioCMSConfigwith thedashboardConfigoptions. The snippet is well-formatted and demonstrates all the default settings clearly.
29-35:dashboardEnabledSection Provides Clear Documentation
The section (lines 29–35) clearly explains the purpose, type, and default value ofdashboardEnabled. The explanation is precise and matches the example usage provided.
38-46: Usage Example fordashboardEnabledis Well-Illustrated
The usage snippet (lines 38–46) effectively demonstrates how to configuredashboardEnabledin the StudioCMS configuration. Using an inline comment for the default value is helpful.
48-65:DashboardRouteOverrideSection is Clear and Consistent
The explanatory text (lines 48–54) along with the usage example (lines 55–65) correctly document thedashboardRouteOverrideoption. The clarity helps users understand how to override the default route.
67-83: Documentation fordeveloperConfigis Informative
ThedeveloperConfigsection (lines 67–83) clearly describes the configuration and provides a practical code example that shows additional developer settings (e.g.,demoMode).
85-102:faviconURLDetails are Clear and Consistent
The section forfaviconURL(lines 85–102) accurately presents the type, default value, and example usage, making it easy for users to understand how to customize the favicon path.
104-121:inject404RouteSection is Properly Documented
The description and usage example forinject404Route(lines 104–121) are clear, and the inline comment reinforces its default behavior.
123-140:versionCheckis Well-Explained
TheversionChecksection (lines 123–140) contains a straightforward explanation and usage example that helps users understand its role in the configuration.
142-158:AuthConfigInitial Section is Clear
The section (lines 142–158) that introducesAuthConfigprovides a concise explanation along with a usage example that clearly indicates how to enable authentication for the dashboard.
160-186:providersConfiguration is Detailed and Helpful
The subsection onproviders(lines 160–186) is detailed and includes multiple authentication provider options. The example effectively demonstrates the object structure required for configuring providers.
188-212:usernameAndPasswordConfigSection is Informative
This part (lines 188–212) clearly explains the settings for username and password configuration, and the usage example is easy for users to follow.
214-228:AuthProvidersType Definition is Clear and Accurate
The type definition forAuthProviders(lines 214–228) is well-documented. It accurately represents the expected properties for different authentication providers.
Oh, the addition of |
@ArmandPhilippot We are hoping to get onto their OSS free Pro plan once our 14 days expire, otherwise we will be sticking with their free version till we are able to get the OSS plan, definitely been fun to play with though! |
4 participants
Description
Adds the French translation of
config-reference/dashboard.Summary by CodeRabbit