docs: add missing documentation#7
Conversation
📝 WalkthroughWalkthroughThe PR adds explicit ChangesNavigation Ordering Infrastructure
Organizations Module Documentation
Email & Templates Documentation
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
apps/docs/src/content/docs/discover/default/en/guides/email.mdx (2)
101-186: ⚡ Quick winClarify the template JSON structure format and schema.
Line 117 states "Templates are stored as a JSON
structurethat FerrisKey renders to MJML and then to HTML," but the example snippet at lines 196–209 shows a raw HTML excerpt with no indication of the JSON wrapper or schema. Users reading the Template API Endpoints section (lines 160–174) will need to POST or PUT astructurefield, but have no documentation of what that JSON should look like or what fields it contains.Provide an example of the complete
structureJSON (or clarify whetherstructureis raw HTML, MJML, or a JSON object describing the email layout), and document the required/optional fields within it.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/src/content/docs/discover/default/en/guides/email.mdx` around lines 101 - 186, The documentation mentions that templates are stored as a JSON structure but does not provide a concrete example or schema. Add a documented example of the complete JSON structure for email templates that shows what fields are required (such as the email layout/content representation) and which are optional. Clarify whether the structure contains raw HTML, MJML markup, or a JSON object schema that describes the email layout, and document all required and optional fields within that structure so users understand exactly what to send in POST and PUT requests to the Template API Endpoints.
87-97: ⚡ Quick winMissing guidance: Where to enable the email type toggles in the Console.
The table documents three realm toggles (
forgot_password_enabled,magic_link_enabled,email_verification_enabled) required to send each email type, but there's no step-by-step guidance on where to find and enable these toggles in the Console. The SMTP configuration steps (lines 54–79) are clear and thorough, but the email type toggles lack equivalent instruction. Users following this guide will configure SMTP but may not know how to activate the actual email types.Consider adding a second step group (after "Configure SMTP in the Console") that walks users through enabling the email type toggles, similar to the SMTP steps.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@apps/docs/src/content/docs/discover/default/en/guides/email.mdx` around lines 87 - 97, The Transactional Emails section documents the three required realm toggles (forgot_password_enabled, magic_link_enabled, email_verification_enabled) in a table but lacks step-by-step guidance on how to enable them in the Console. Add a new instruction section after the SMTP configuration steps that walks users through navigating to Realm Settings in the Console and enabling each of the three email type toggles (Password reset, Magic link, and Email verification), providing equivalent clarity and detail to the existing SMTP configuration instructions.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/docs/src/content/docs/cli/_meta.json`:
- Line 3: The title field in the _meta.json file has been changed from the
standard uppercase "CLI" abbreviation to "Cli". Restore it back to "CLI" to
maintain consistency with the conventional industry standard abbreviation for
Command Line Interface.
---
Nitpick comments:
In `@apps/docs/src/content/docs/discover/default/en/guides/email.mdx`:
- Around line 101-186: The documentation mentions that templates are stored as a
JSON structure but does not provide a concrete example or schema. Add a
documented example of the complete JSON structure for email templates that shows
what fields are required (such as the email layout/content representation) and
which are optional. Clarify whether the structure contains raw HTML, MJML
markup, or a JSON object schema that describes the email layout, and document
all required and optional fields within that structure so users understand
exactly what to send in POST and PUT requests to the Template API Endpoints.
- Around line 87-97: The Transactional Emails section documents the three
required realm toggles (forgot_password_enabled, magic_link_enabled,
email_verification_enabled) in a table but lacks step-by-step guidance on how to
enable them in the Console. Add a new instruction section after the SMTP
configuration steps that walks users through navigating to Realm Settings in the
Console and enabling each of the three email type toggles (Password reset, Magic
link, and Email verification), providing equivalent clarity and detail to the
existing SMTP configuration instructions.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 48b3321a-67a0-4ae6-9c1d-a7082d2d015d
📒 Files selected for processing (16)
apps/docs/src/components/project-tabs.tsxapps/docs/src/content/docs/cli/_meta.jsonapps/docs/src/content/docs/discover/_meta.jsonapps/docs/src/content/docs/discover/default/en/guides/architecture.mdxapps/docs/src/content/docs/discover/default/en/guides/contributing.mdxapps/docs/src/content/docs/discover/default/en/guides/email.mdxapps/docs/src/content/docs/discover/default/en/what-is-ferriskey.mdxapps/docs/src/content/docs/kubernetes/_meta.jsonapps/docs/src/content/docs/learn/_meta.jsonapps/docs/src/content/docs/modules/_meta.jsonapps/docs/src/content/docs/modules/default/en/organization/_meta.jsonapps/docs/src/content/docs/modules/default/en/organization/attributes.mdxapps/docs/src/content/docs/modules/default/en/organization/members.mdxapps/docs/src/content/docs/modules/default/en/organization/overview.mdxapps/docs/src/content/docs/modules/default/en/overview.mdxapps/docs/src/lib/docs.ts
| { | ||
| "icon": "terminal", | ||
| "title": "CLI" | ||
| "title": "Cli", |
There was a problem hiding this comment.
Restore standard "CLI" abbreviation casing.
The title was changed from "CLI" to "Cli", but "CLI" (all uppercase) is the conventional abbreviation for "Command Line Interface" and should be preserved for consistency with industry standards.
📝 Suggested fix
- "title": "Cli",
+ "title": "CLI",📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| "title": "Cli", | |
| "title": "CLI", |
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@apps/docs/src/content/docs/cli/_meta.json` at line 3, The title field in the
_meta.json file has been changed from the standard uppercase "CLI" abbreviation
to "Cli". Restore it back to "CLI" to maintain consistency with the conventional
industry standard abbreviation for Command Line Interface.
2 participants
Summary by CodeRabbit
New Features
Documentation