Update theme-variants.md

[pnzrr]

Summary by CodeRabbit

• Documentation
  • Added detailed instructions on viewing and testing theme variants, including steps for assigning variants and using them in different contexts.
  • Provided guidance on accessing theme variant names within email templates.

[coderabbitai]

Walkthrough

The documentation for theme variants was expanded by adding two new sections. The first section, "Viewing your variants," outlines the process for assigning and testing theme variants, including steps for configuring realms, clients, and storybook usage. The second section, "In Emails," describes how to reference the theme variant name within email templates using a specific variable syntax. No changes were made to code or exported entities.

Changes

File(s)	Change Summary
features/theme-variants.md	Added sections detailing how to view theme variants in the UI and reference them in email templates.

Poem

In the meadow of docs, new guidance appears,
On variants and emails, it now rings clear.
Assign, preview, and test with delight,
Even your emails can wear themes at night.
With each new section, the knowledge grows—
A bunny hops forward, where clarity flows!
🐇✨

---

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

• 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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

features/theme-variants.md (2)

54-59: Enhance clarity for "Viewing your variants" steps
The numbered list is clear, but step 3's inline snippet is truncated and the JSX tag isn't closed. Consider expanding it into a fenced code block and ensuring proper markdown escaping of the braces. For example:

- 3. Apply the theme name in the `kcContext` of the storybook story: `<KcPageStory kcContext={{ themeName: "chocolate" }}...`
+ 3. Apply the theme name in the `kcContext` of the Storybook story:
+    ```tsx
+    <KcPageStory kcContext={{ themeName: "chocolate" }} />
+    ```

This makes the example self-contained and avoids confusion around the ellipsis.

---

107-109: Clarify "In Emails" usage with a concrete example
You mention accessing ${xKeycloakify.themeName}, but users may benefit from seeing it in context. For instance, in a Freemarker email template:

<p>Your selected theme variant is ${xKeycloakify.themeName}.</p>

You could also note which templating engines (e.g., FTL, Mustache) support this variable.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 1798626 and 6d098d8.

📒 Files selected for processing (1)

• features/theme-variants.md (2 hunks)