Fix/Clarify what is translated

[clairekinde11]

Small change to clarify what gets translated when you select another language.

Summary by CodeRabbit

• Documentation
  • Enhanced clarity and precision in the internationalization documentation for user-facing authentication pages.
  • Updated section title to better reflect content regarding translatable items.
  • Refined descriptions of translated screens and included one-time code emails.
  • Retained instructions for managing language settings and details on language display priorities.

[coderabbitai]

Walkthrough

The pull request involves updating the internationalization documentation in the src/content/docs/design/pages/internationalization.mdx file. The changes primarily focus on improving the clarity and precision of language translation details for user-facing authentication pages. The document's language has been refined to be more concise, with subtle modifications to section titles and descriptions that better explain what can be translated, including one-time code emails.

Changes

File	Change Summary
src/content/docs/design/pages/internationalization.mdx	- Updated section title from "What screens can be translated?" to "What gets translated?" - Refined description of translatable items - Added "one-time code emails" to list of translated items - Maintained overall structure with more precise language

Suggested Reviewers

• marcosmartini

Possibly related PRs

• fix/update-mfa-no-recovery-codes #199: Enhancing documentation clarity for multi-factor authentication
• Fix/sessions across domains #202: Updating authentication documentation
• Fix/Clarify how MFA works in orgs #211: Clarifying multi-factor authentication settings
• Fix/Navigation to user access options #224: Improving user management functionalities
• Fix/update to verifying user identity via import #225: Addressing user identity verification during imports
• Fix/Clarify approach to setting token limits #239: Discussing token management
• Fix/Access your api vi token #241: Clarifying API access processes
• Fix/encryption code for cloudflare #272: Enhancing documentation for authentication page encryption settings

Poem

🌐 A Rabbit's Translation Tale 🐰

Words dance from screen to screen,
Languages blend, crisp and clean,
One-time codes in every tongue,
Authentication's song is sung!

Clarity leaps with every line, 🦘
International borders now realign! 🌍

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[cloudflare-workers-and-pages]

Deploying kinde-docs-previews with    Cloudflare Pages

Latest commit:	3c17f14
Status:	✅  Deploy successful!
Preview URL:	https://fc1c82c9.kinde-docs-previews.pages.dev
Branch Preview URL:	https://fix-update-i18n.kinde-docs-previews.pages.dev

View logs

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/content/docs/design/pages/internationalization.mdx (1)

18-18: Add hyphen to compound adjective "user-facing"

The content changes improve clarity by specifying email translations. However, when "user facing" modifies "authentication pages", it should be hyphenated.

-Only the user facing authentication pages are translated.
+Only the user-facing authentication pages are translated.

🧰 Tools

🪛 LanguageTool

[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ll. ## What gets translated? Only the user facing authentication pages are translated. Th...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 820a6a0 and 3c17f14.

📒 Files selected for processing (1)

• src/content/docs/design/pages/internationalization.mdx (1 hunks)

🧰 Additional context used

🪛 LanguageTool

src/content/docs/design/pages/internationalization.mdx

[uncategorized] ~18-~18: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ll. ## What gets translated? Only the user facing authentication pages are translated. Th...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🔇 Additional comments (1)

src/content/docs/design/pages/internationalization.mdx (1)

16-16: LGTM! Title change improves clarity

The new title "What gets translated?" is more accurate and inclusive as it better encompasses all translatable elements, including both screens and emails.