Conversation
Added all pages to custom page list
|
""" WalkthroughThe documentation was updated to adjust heading levels for major sections, add a warning about customizing routes in production, and significantly expand the list of customizable routes with new categories and route names. Minor formatting improvements and clarifications were also made, without altering any functional descriptions. Changes
Suggested reviewers
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/design/customize-with-code/understand-page-design.mdx(5 hunks)
🔇 Additional comments (4)
src/content/docs/design/customize-with-code/understand-page-design.mdx (4)
147-147: Section promoted to H2 as intended
Updating “Page structure in the Git directory” from H3 to H2 correctly elevates its importance in the document hierarchy.
165-165: Updated Kinde.json section to H2
The “Kinde.json” heading is now an H2, matching the pattern for major sections.
180-180: Elevated “Which pages can I customize?” to H2
Promoting this section to H2 aligns it with other top-level topics.
186-190: Added warning aside for non-production testing
The new<Aside type="warning">block effectively reminds users to apply custom code in a non-production environment first, which is a valuable best practice.
|
|
||
| </Aside> | ||
|
|
||
| Common routes |
There was a problem hiding this comment.
Missing markdown for “Common routes” heading
The “Common routes” line is not prefixed with a heading marker. It should be defined as an H3 (e.g., ### Common routes) under the current H2 context to maintain consistent styling.
Please apply:
- Common routes
+ ### Common routes📝 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.
| Common routes | |
| ### Common routes |
🤖 Prompt for AI Agents
In src/content/docs/design/customize-with-code/understand-page-design.mdx at
line 192, the text "Common routes" is missing the markdown heading syntax. Add
the H3 markdown prefix by changing the line to "### Common routes" to ensure
consistent heading styling under the current H2 context.
Deploying kinde-docs-previews with
|
| Latest commit: |
bac54d0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3f02ef59.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://feat-custom-ui-pages.kinde-docs-previews.pages.dev |
|
|
||
| `(index)` - If someone visits the root domain for your business, e.g. `https://<yourdomain>.kinde.com` | ||
|
|
||
| Errors |
There was a problem hiding this comment.
Had a stab at some groupings
## Common pages
These are the most frequently used or fallback pages.
* `(default)` – Fallback template used when a specific page is not found.
* `(register)` – The sign-up page.
* `(login)` – The sign-in page.
* `(index)` – Landing page when visiting the root domain (e.g. `https://<yourdomain>.kinde.com`).
## Authentication
Pages involved in initiating authentication flows.
* `(register)` – The sign-up page.
* `(login)` – The sign-in page.
* `(sso_home_realm)` – Displayed when a user selects “Continue with SSO” to choose their identity provider.
* `(provide_email)` – Shown when using a social login provider that does not return an email address.
* `(clickwrap)` – Displays terms and conditions or agreements that must be accepted.
## Password flows
Used in password-based authentication and recovery.
* `(verify_password)` – Shown during sign-in when using a password-based method.
* `(set_password)` – Shown during a password-based sign-up flow.
* `(reset_password_verify_email_otp)` – First step of the reset flow where the user verifies identity using an email OTP.
* `(reset_password)` – Password entry screen shown after verification during the reset flow.
## One-Time Passcode (OTP) verification
Used in sign-in and sign-up flows with OTP (email or phone).
* `(sign_in_use_email_otp)` – Sign in with a one-time email code.
* `(sign_up_use_email_otp)` – Sign up with a one-time email code.
* `(sign_in_sign_up_use_phone_otp)` – Sign in or sign up with a one-time phone code.
## Multi-Factor Authentication (MFA)
Shown after primary authentication when MFA is required or being set up.
* `(mfa_method_selection)` – User selects their preferred MFA method.
* `(mfa_authenticator_app)` – Setup screen for using an authenticator app.
* `(mfa_setup_email)` – Setup screen for email-based MFA.
* `(mfa_setup_phone)` – Setup screen for phone-based MFA.
* `(mfa_use_email_otp)` – Enter a one-time email code for MFA.
* `(mfa_use_phone_otp)` – Enter a one-time phone code for MFA.
* `(mfa_use_recovery_code)` – Enter a recovery code if unable to use other MFA methods.
* `(mfa_view_recovery_codes)` – View and save MFA recovery codes.
## Billing (coming soon)
Pages related to choosing a plan and making a payment.
* `(choose_plan)` – User selects a subscription plan.
* `(collect_payment_details)` – User enters billing information.
* `(subscription_success)` – Confirmation page shown after successful subscription.
## Early access
Pages for gated access to your product before full launch.
* `(request_access)` – Request early access to your product.
* `(request_access_success)` – Confirmation page after a request is submitted.
## Error pages
Shown when a user encounters an error state.
* `(account_locked)` – The user’s account has been locked.
* `(account_not_found)` – No account was found for the entered credentials.
* `(invalid_redirect_url)` – The redirect URL is invalid or not on the allowed list.
* `(error)` – Generic error screen.
Updated list with Dave's definitions
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
src/content/docs/design/customize-with-code/understand-page-design.mdx (4)
186-190: Ensure consistent<Aside>usageThe new
<Aside type="warning">admonition clearly warns about production pitfalls. The earlier<Aside>at lines 141–145 uses the default type; consider explicitly specifying its type (e.g.,type="info") to maintain consistency across all asides.
192-200: Avoid duplicate entries across categoriesIn the “Common pages” list,
(register)and(login)also appear under “Authentication.” If the intent is to distinguish overall fallback pages from flow-specific pages, consider adding a clarifying note or removing duplicates to prevent confusion.
214-214: Improve grammar in bullet descriptionAt
(verify_password), consider including an article for clarity, e.g.:
* (verify_password) – Shown during the sign-in process when using a password-based method.🧰 Tools
🪛 LanguageTool
[grammar] ~214-~214: Before the countable noun ‘during’ an article or a possessive pronoun is necessary.
Context: .... *(verify_password)– Shown during sign-in when using a password-based method. * `...(IN_NN_CC_VBG)
242-242: Consider more concise phrasingThe sentence “Pages related to choosing a plan and making a payment.” could be streamlined to “Pages for plan selection and payment processing.”
🧰 Tools
🪛 LanguageTool
[style] ~242-~242: ‘making a payment’ might be wordy. Consider a shorter alternative.
Context: ...) Pages related to choosing a plan and making a payment. *(choose_plan)– User selects a su...(EN_WORDINESS_PREMIUM_MAKING_A_PAYMENT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/design/customize-with-code/understand-page-design.mdx(4 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/design/customize-with-code/understand-page-design.mdx
[grammar] ~214-~214: Before the countable noun ‘during’ an article or a possessive pronoun is necessary.
Context: .... * (verify_password) – Shown during sign-in when using a password-based method. * `...
(IN_NN_CC_VBG)
[style] ~242-~242: ‘making a payment’ might be wordy. Consider a shorter alternative.
Context: ...) Pages related to choosing a plan and making a payment. * (choose_plan) – User selects a su...
(EN_WORDINESS_PREMIUM_MAKING_A_PAYMENT)
🔇 Additional comments (6)
src/content/docs/design/customize-with-code/understand-page-design.mdx (6)
147-147: Promoted main section headings to level 2The sections “Page structure in the Git directory”, “Kinde.json”, and “Which pages can I customize?” have been elevated from H3 to H2. This improves the document hierarchy—please confirm it aligns with the overall outline and table of contents.
Also applies to: 165-165, 180-180
201-208: Authentication category is well-definedThe “Authentication” section clearly lists the relevant pages with concise descriptions. Formatting and terminology are consistent.
219-225: OTP verification section is clearThe “One-Time Passcode (OTP) verification” category and its bullet points are well-structured and easy to follow.
227-238: MFA section looks solidThe “Multi-Factor Authentication (MFA)” list is comprehensive and the descriptions are clear.
248-253: Early access section looks goodThe “Early access” category and its descriptions are concise and consistent.
255-262: Error pages section is well-structuredThe “Error pages” category and its bullet points are correctly formatted and informative.
2 participants
Added all pages to custom page list
Summary by CodeRabbit