Feat/page content #317
Feat/page content #317
Conversation
New overview topic
|
Warning Rate limit exceeded@clairekinde11 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 16 minutes and 53 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
WalkthroughThis pull request introduces comprehensive updates to the documentation for the Kinde platform, focusing on design, content customization, and user experience. The changes include reorganizing sidebar navigation, updating content management instructions, introducing new documentation pages about page layouts, translations, and content customization, and refining the terminology and navigation paths for various design and authentication-related sections. Changes
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
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? 🪧 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 (
|
![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 (7)
src/content/docs/design/forms/set-up-subscription-form.mdx (1)
Line range hint
22-28: Fix the bullet point formatting in the code snippet steps.The code snippet steps should be properly formatted for consistency. The indentation suggests these are sub-steps, but they're actually part of step 5.
4. Select **Save and generate code**. - 5. Use this code to add the subscription page to your website. - - `HTML` - Add this to your site page to embed the form. - - `CSS` - Copy into your page header. To apply your own style, add a style block and use custom class names to apply your designs. - - `JS` - Copy and paste this somewhere in the page markup. Putting it after the provided HTML markup (above) is ideal. + 5. Use this code to add the subscription page to your website: + 1. `HTML` - Add this to your site page to embed the form. + 2. `CSS` - Copy into your page header. To apply your own style, add a style block and use custom class names to apply your designs. + 3. `JS` - Copy and paste this somewhere in the page markup. Putting it after the provided HTML markup (above) is ideal.src/content/docs/design/pages/marketing-consent.mdx (1)
34-34: Fix duplicate word "Select".Remove the duplicate word for clarity.
-4. Select Select **Save**. +4. Select **Save**.🧰 Tools
🪛 LanguageTool
[duplication] ~34-~34: Possible typo: you repeated a word.
Context: ...field and make the required changes. 4. Select Select Save. 5. To preview, select **Sign...(ENGLISH_WORD_REPEAT_RULE)
src/content/docs/design/content-customization/update-auth-page-content.mdx (1)
19-19: Fix grammar: "build" should be "built".Correct the verb form for proper grammar.
-If your application is build for [multiple languages] +If your application is built for [multiple languages]🧰 Tools
🪛 LanguageTool
[grammar] ~19-~19: Make sure that the noun ‘build’ is correct. Did you mean the past participle “built”?
Context: ...te page content If your application is build for [multiple languages](https://docs.k...(BE_VB_OR_NN)
src/content/docs/design/pages/page-layout.mdx (2)
45-45: Fix typo in "cusomizations".Correct the spelling.
-## Other cusomizations you might want to apply +## Other customizations you might want to apply
15-15: Maintain consistent hyphenation for "sign-up".For consistency across the documentation, "sign-up" should be hyphenated when used as a compound modifier.
-sign up page - what a user sees when they first sign up to your business +sign-up page - what a user sees when they first sign up to your business -Subscription page - the sign up page for new subscribers +Subscription page - the sign-up page for new subscribers -[Add a marketing consent checkbox to the sign up page] +[Add a marketing consent checkbox to the sign-up page]Also applies to: 19-19, 49-49
src/content/docs/design/content-customization/how-translation-works.mdx (2)
43-43: Document the<img_url>placeholder.The example code uses a placeholder without explaining what should be used in its place. Consider adding a comment or replacing it with a more descriptive example.
-<img src={<img_url>} alt={content.logoAlt} /> +<img src={logoUrl} alt={content.logoAlt} /> {/* Replace logoUrl with your actual image URL */}
16-16: Improve readability with proper punctuation.Add commas to improve readability and flow of sentences.
-Language detection is automatically handled for you and Kinde gives display priority +Language detection is automatically handled for you, and Kinde gives display priority -After the priority list outlined above Kinde will fall back +After the priority list outlined above, Kinde will fall backAlso applies to: 28-28
🧰 Tools
🪛 LanguageTool
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... detection is automatically handled for you and Kinde gives display priority to lan...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (12)
src/content/docs/design/brand/remove-kinde-branding.mdx(2 hunks)src/content/docs/design/content-customization/how-content-is-managed.mdx(1 hunks)src/content/docs/design/content-customization/how-translation-works.mdx(1 hunks)src/content/docs/design/content-customization/update-auth-page-content.mdx(1 hunks)src/content/docs/design/forms/set-up-subscription-form.mdx(1 hunks)src/content/docs/design/pages/design-your-welcome-pages.mdx(3 hunks)src/content/docs/design/pages/internationalization.mdx(1 hunks)src/content/docs/design/pages/link-to-homepage.mdx(1 hunks)src/content/docs/design/pages/marketing-consent.mdx(2 hunks)src/content/docs/design/pages/page-layout.mdx(1 hunks)src/content/docs/design/pages/set-up-the-request-access-page.mdx(2 hunks)src/data/sidebarData.ts(1 hunks)
✅ Files skipped from review due to trivial changes (3)
- src/content/docs/design/pages/link-to-homepage.mdx
- src/content/docs/design/content-customization/how-content-is-managed.mdx
- src/content/docs/design/pages/internationalization.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/design/pages/page-layout.mdx
[uncategorized] ~19-~19: The noun “sign-up” is spelled with a hyphen.
Context: ... the company. - Subscription page - the sign up page for new subscribers (if you use th...
(SIGN_UP_HYPHEN)
[style] ~31-~31: This expression usually appears with a “please” in front of it.
Context: ...t environment, where it should be fine. Let us know if you’re having issues. ...
(INSERT_PLEASE)
[uncategorized] ~49-~49: The noun “sign-up” is spelled with a hyphen.
Context: ...Add a marketing consent checkbox to the sign up page](/design/pages/marketing-consent/)...
(SIGN_UP_HYPHEN)
src/content/docs/design/content-customization/update-auth-page-content.mdx
[grammar] ~19-~19: Make sure that the noun ‘build’ is correct. Did you mean the past participle “built”?
Context: ...te page content If your application is build for [multiple languages](https://docs.k...
(BE_VB_OR_NN)
[style] ~24-~24: This phrasing can be overused. Try elevating your writing with a more formal alternative.
Context: ...tc. 4. Make the changes to the content. If you want, you can use text variables, explained ...
(IF_YOU_WANT)
src/content/docs/design/pages/marketing-consent.mdx
[duplication] ~34-~34: Possible typo: you repeated a word.
Context: ...field and make the required changes. 4. Select Select Save. 5. To preview, select **Sign...
(ENGLISH_WORD_REPEAT_RULE)
src/content/docs/design/content-customization/how-translation-works.mdx
[uncategorized] ~16-~16: Possible missing comma found.
Context: ... detection is automatically handled for you and Kinde gives display priority to lan...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~28-~28: A comma might be missing here.
Context: ... app. After the priority list outlined above Kinde will fall back to US English as a...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[typographical] ~28-~28: Usually, there’s no comma before “if”.
Context: ...fall back to US English as a last resort, if a translation is not available. ### Wi...
(IF_NO_COMMA)
[style] ~32-~32: This phrase is redundant. Consider using “inside”.
Context: ... ### Widget translations Translations inside of the Kinde widget are taken care of by K...
(OUTSIDE_OF)
[style] ~32-~32: This phrase is redundant. Consider using “inside”.
Context: ...guage from your Page content settings inside of Kinde and apply them to the widget. #...
(OUTSIDE_OF)
🔇 Additional comments (4)
src/data/sidebarData.ts (1)
197-197: LGTM! The sidebar reorganization improves content discoverability.The changes logically group related items and introduce content customization as a distinct category, which aligns well with the new Information Architecture.
Also applies to: 203-203, 208-208, 213-214, 221-225
src/content/docs/design/brand/remove-kinde-branding.mdx (1)
5-5: LGTM! The changes improve navigation and plan clarity.Moving branding to the top of the section makes sense as it's a fundamental customization step. The updated plan reference is more inclusive and maintainable.
Also applies to: 17-17
src/content/docs/design/forms/set-up-subscription-form.mdx (1)
20-20: LGTM! The navigation path and header updates improve clarity.The changes align well with the new Information Architecture and make the content more specific.
Also applies to: 22-22
src/content/docs/design/pages/design-your-welcome-pages.mdx (1)
3-3: LGTM! Content structure and updates align well with the new IA.The changes effectively reorganize the content to focus on brand experience defaults while maintaining clarity and usability.
Also applies to: 23-23, 62-79
| 1. Go to **Design > Lead generation > Request access**. | ||
| 2. Make your design and layout selections. For tips on how to change things, see [Design your welcome pages](/design/pages/design-your-welcome-pages/). | ||
| 3. Enter the **Success link URL**. | ||
| 4. Switch the **Page details** button to **Live** and select **Save**. | ||
| 5. You need to separately set up the **Request Access URL** on your website. | ||
| 4. Select **Preview** to view how the page will look. | ||
| 5. Once you like it, switch the **Page details** button to **Live** and then select **Save**. | ||
| 6. To change the content on the page, go to **Page content** in the menu, and select the *Request access** page. Make the changes you want in all the relevant languages and **Save**. | ||
| 5. You'll need to separately set up the **Request Access URL** on your website. |
There was a problem hiding this comment.
Fix step numbering and formatting issues.
There are several issues in the steps:
- Step 5 appears twice
- There's a typo in step 6 (
*Requestshould be**Request) - The last step about URL setup should be step 7, not 5
Apply this diff to fix the issues:
1. Go to **Design > Lead generation > Request access**.
2. Make your design and layout selections. For tips on how to change things, see [Design your welcome pages](/design/pages/design-your-welcome-pages/).
3. Enter the **Success link URL**.
4. Select **Preview** to view how the page will look.
5. Once you like it, switch the **Page details** button to **Live** and then select **Save**.
-6. To change the content on the page, go to **Page content** in the menu, and select the *Request access** page. Make the changes you want in all the relevant languages and **Save**.
-5. You'll need to separately set up the **Request Access URL** on your website.
+6. To change the content on the page, go to **Page content** in the menu, and select the **Request access** page. Make the changes you want in all the relevant languages and **Save**.
+7. You'll need to separately set up the **Request Access URL** on your website.📝 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.
| 1. Go to **Design > Lead generation > Request access**. | |
| 2. Make your design and layout selections. For tips on how to change things, see [Design your welcome pages](/design/pages/design-your-welcome-pages/). | |
| 3. Enter the **Success link URL**. | |
| 4. Switch the **Page details** button to **Live** and select **Save**. | |
| 5. You need to separately set up the **Request Access URL** on your website. | |
| 4. Select **Preview** to view how the page will look. | |
| 5. Once you like it, switch the **Page details** button to **Live** and then select **Save**. | |
| 6. To change the content on the page, go to **Page content** in the menu, and select the *Request access** page. Make the changes you want in all the relevant languages and **Save**. | |
| 5. You'll need to separately set up the **Request Access URL** on your website. | |
| 1. Go to **Design > Lead generation > Request access**. | |
| 2. Make your design and layout selections. For tips on how to change things, see [Design your welcome pages](/design/pages/design-your-welcome-pages/). | |
| 3. Enter the **Success link URL**. | |
| 4. Select **Preview** to view how the page will look. | |
| 5. Once you like it, switch the **Page details** button to **Live** and then select **Save**. | |
| 6. To change the content on the page, go to **Page content** in the menu, and select the **Request access** page. Make the changes you want in all the relevant languages and **Save**. | |
| 7. You'll need to separately set up the **Request Access URL** on your website. |
|
|
||
| ## What can be edited? | ||
|
|
||
| All the content elements on pages, including headings, descriptions, field labels, etc. can be edited. |
There was a problem hiding this comment.
@clairekinde11 as of now, it's still just the handful of fields we allowed previously we haven't opened the floodgates yet.
We added edit functionality for these few fields that had high customer asks:
Sign up screen
- email label
Sign in screen
- email label
- Account not found error message
|
|
||
| Translations inside of the Kinde widget are taken care of by Kinde. We will grab the copy from the relevant route and language from your `Page content` settings inside of Kinde and apply them to the widget. | ||
|
|
||
| ### Page translations |
There was a problem hiding this comment.
The widget/page sections are really specific to custom UI. If you're not using custom UI you probably won't make much sense of it
|
|
||
| ### Update page content | ||
|
|
||
| If your application is build for [multiple languages](https://docs.kinde.com/design/pages/internationalization), select these first in Kinde. |
|
|
||
| `${enterprise_provider_name}` // for use on the enterprise SSO buttons | ||
|
|
||
| **Verify password** |
There was a problem hiding this comment.
@clairekinde11 should we axe the ones you can't edit the fields with those relevant placeholders yet. i.e remove
- Verify password
- SMS verify code page
- Sign in page
- Sign up page
Deploying kinde-docs-previews with
|
| Latest commit: |
1317dfe
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a0e71407.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://feat-page-content.kinde-docs-previews.pages.dev |
Update to all pages to refer to new IA
Update to procedures to reflect new IA
New topics for page content editing
Renamed topic categories in section
This was a fairly quick update - some refinement to come to add cross-referencing and related topics cleanup.
Summary by CodeRabbit
Documentation Updates
Content Changes