Conversation
WalkthroughThis update revises several Kinde documentation pages. The changes clarify the environment structure and usage guidelines, update step-by-step instructions for setting up and managing multiple businesses, and adjust visual formatting on design pages. The Quick Start guide now reflects a new navigation sequence, while account management instructions have been updated for clearer user navigation. No modifications were made to the declarations of exported or public entities. Changes
Sequence Diagram(s)sequenceDiagram
participant U as User
participant UI as Kinde UI
U->>UI: Click bottom-left user profile
UI-->>U: Display options (Add Business, Switch Business)
alt Add Business
U->>UI: Select "Add Business"
UI-->>U: Show business addition form
else Switch Business
U->>UI: Select "Switch Business"
UI-->>U: Display list of businesses
end
sequenceDiagram
participant U as User
participant App as Kinde App
U->>App: Click app tile ("View details")
App-->>U: Show business details with "Quick Start" option
U->>App: Select "Quick Start" from menu
App-->>U: Present Quick Start guide steps
Suggested labels
Suggested reviewers
Poem
Tip 🌐 Web search-backed reviews and chat
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 (
|
Deploying kinde-docs-previews with
|
| Latest commit: |
b674a89
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fb86d457.kinde-docs-previews.pages.dev |
| Branch Preview URL: | https://feat-shell-changes.kinde-docs-previews.pages.dev |
![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/build/set-up-options/run-multiple-businesses.mdx (2)
19-24: Fix Markdown Formatting in “Add a New Business” Steps
In step 2, the link text is rendered as *Switch business instead of Switch business. Please update the markdown to ensure proper emphasis.
Suggested diff:-2. From the menu, select **Switch business*. A screen showing all your businesses opens. +2. From the menu, select **Switch business**. A screen showing all your businesses opens.
28-30: Correct Markdown Formatting in “Switch Between Businesses” Section
Similarly, step 2 in the “Switch between businesses” section has a markdown formatting issue. Replace *Switch business with Switch business for proper rendering.
Suggested diff:-2. From the menu, select **Switch business*. A screen showing all your businesses opens. +2. From the menu, select **Switch business**. A screen showing all your businesses opens.src/content/docs/get-started/guides/first-things-first.mdx (2)
24-24: Enhance Image Alt Text for Accessibility
The newly added image improves visual guidance; however, the alt text “quickstart example” is somewhat generic. Consider using a more descriptive alt text (e.g. “Quick Start guide example showing the UI layout”) to improve accessibility.
32-39: Refine Step-by-Step Instructions Formatting
The updated step instructions clearly guide users on accessing the Quick Start guide. One minor improvement: in step 3, consider moving the trailing period outside of the bold formatting.
Suggested diff:-3. Select the relevant tab: **Starter kit** or **Existing codebase.** +3. Select the relevant tab: **Starter kit** or **Existing codebase**.src/content/docs/build/environments/environments.mdx (3)
12-12: Grammar Adjustment in Environment Description
In the sentence “Higher plans come with additional non-production environments, so you can add staging, testing, beta, etc. to meet your team’s needs,” the comma before “so” may be removed to improve flow.
Suggested diff:-... additional non-production environments, so you can add staging, testing, beta, etc. +... additional non-production environments so you can add staging, testing, beta, etc.🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Do not use a comma before “so” when introducing a dependent clause.
Context: ...h additional non-production environments, so you can add staging, testing, beta, ...(NO_COMMA_BEFORE_SO)
63-66: Insert Missing Comma for Clarity in Deletion Instructions
In the instruction “On the environment you want to delete select the three dots, then select Delete environment,” a comma after “delete” will improve readability.
Suggested diff:-On the environment you want to delete select the three dots, then select **Delete environment**. +On the environment you want to delete, select the three dots, then select **Delete environment**.🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: Possible missing comma found.
Context: ...ts**. 2. On the environment you want to delete select the three dots, then select **De...(AI_HYDRA_LEO_MISSING_COMMA)
67-67: Vary Confirmation Phrasing for Delete Action
Consider rephrasing “Confirm you want to delete the environment. This action is irreversible.” to add variety and enhance clarity. For example, “Confirm the deletion of the environment (this action cannot be undone).”🧰 Tools
🪛 LanguageTool
[style] ~67-~67: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Delete environment. 3. Confirm you want to delete the environment. This action is ...(REP_WANT_TO_VB)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/content/docs/build/environments/environments.mdx(1 hunks)src/content/docs/build/set-up-options/run-multiple-businesses.mdx(1 hunks)src/content/docs/design/pages/page-layout.mdx(0 hunks)src/content/docs/design/pages/set-up-the-request-access-page.mdx(1 hunks)src/content/docs/get-started/guides/first-things-first.mdx(2 hunks)src/content/docs/manage-your-account/business-information/update-your-details.mdx(1 hunks)
💤 Files with no reviewable changes (1)
- src/content/docs/design/pages/page-layout.mdx
✅ Files skipped from review due to trivial changes (1)
- src/content/docs/design/pages/set-up-the-request-access-page.mdx
🧰 Additional context used
🪛 LanguageTool
src/content/docs/build/environments/environments.mdx
[uncategorized] ~12-~12: Do not use a comma before “so” when introducing a dependent clause.
Context: ...h additional non-production environments, so you can add staging, testing, beta, ...
(NO_COMMA_BEFORE_SO)
[grammar] ~32-~32: The noun “third party” is written as two words.
Context: ...rprise connections) are set up with the third-party’s Client ID and Client secret. If you l...
(THE_THIRD_PARTY)
[duplication] ~32-~32: Possible typo: you repeated a word.
Context: ...ring setup, Kinde’s credentials will be used used as a proxy, and rate limits will apply....
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~66-~66: Possible missing comma found.
Context: ...ts**. 2. On the environment you want to delete select the three dots, then select **De...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~67-~67: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Delete environment. 3. Confirm you want to delete the environment. This action is ...
(REP_WANT_TO_VB)
🔇 Additional comments (1)
src/content/docs/manage-your-account/business-information/update-your-details.mdx (1)
20-22: Update UI Instruction for Changing Sign‑In Name
The instruction has been updated to “go to the bottom‑left of screen and select your avatar,” which aligns well with the changes in other documentation files. Verify that the UI reflects this change to ensure a consistent user experience.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
src/content/docs/build/environments/environments.mdx (5)
12-12: Refine Comma Usage for Clarity
The sentence “Higher plans come with additional non-production environments, so you can add staging, testing, beta, etc. to meet your team’s needs.” contains a comma before “so” that might not be necessary. Consider removing it to improve readability and adhere to common style guidelines.
Tags:🧰 Tools
🪛 LanguageTool
[uncategorized] ~12-~12: Do not use a comma before “so” when introducing a dependent clause.
Context: ...h additional non-production environments, so you can add staging, testing, beta, ...(NO_COMMA_BEFORE_SO)
14-18: Effective Use of the Aside Block
The aside block clearly emphasizes the importance of using the default production environment. For a slightly more formal tone, you might rephrase “the one you got when you first signed up to Kinde” to something like “the default production environment provided upon signup.”
Tags:
32-32: Ensure Consistent Noun Formatting
In the phrase “...set up with the third-party’s Client ID and Client secret,” the possessive form “third-party’s” is used. When referring to the noun, style guidelines often prefer “third party’s” (i.e. without the hyphen). Consider updating it for consistency:-... set up with the third-party’s Client ID and Client secret. +... set up with the third party’s Client ID and Client secret.Tags:
🧰 Tools
🪛 LanguageTool
[grammar] ~32-~32: The noun “third party” is written as two words.
Context: ...rprise connections) are set up with the third-party’s Client ID and Client secret. If you l...(THE_THIRD_PARTY)
61-67: Enhance Clarity in Deletion Instructions
In the “## Delete a non-production environment” section:
- Step 2: There appears to be a missing comma. Consider changing:
-2. On the environment you want to delete select the three dots, then select **Delete environment**. +2. On the environment you want to delete, select the three dots, then select **Delete environment**.- Step 3: The phrasing “Confirm you want to delete the environment. This action is irreversible.” has been flagged as repetitive in nearby text. You might consider rephrasing for variety (e.g., “Confirm the deletion. Note that this action is irreversible.”).
Tags:🧰 Tools
🪛 LanguageTool
[uncategorized] ~66-~66: Possible missing comma found.
Context: ...ts**. 2. On the environment you want to delete select the three dots, then select **De...(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~67-~67: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Delete environment. 3. Confirm you want to delete the environment. This action is ...(REP_WANT_TO_VB)
69-71: Informative Note on Data Movement Between Environments
The section “## Move data between environments” clearly explains that transferring data or settings must be done manually. As an optional refinement, you might consider using “transfer” instead of “shift” to align with common technical terminology.
Tags:
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/build/environments/environments.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/build/environments/environments.mdx
[uncategorized] ~12-~12: Do not use a comma before “so” when introducing a dependent clause.
Context: ...h additional non-production environments, so you can add staging, testing, beta, ...
(NO_COMMA_BEFORE_SO)
[grammar] ~32-~32: The noun “third party” is written as two words.
Context: ...rprise connections) are set up with the third-party’s Client ID and Client secret. If you l...
(THE_THIRD_PARTY)
[uncategorized] ~66-~66: Possible missing comma found.
Context: ...ts**. 2. On the environment you want to delete select the three dots, then select **De...
(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~67-~67: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ... Delete environment. 3. Confirm you want to delete the environment. This action is ...
(REP_WANT_TO_VB)
🔇 Additional comments (6)
src/content/docs/build/environments/environments.mdx (6)
20-20: Clear Instruction on Environment Visibility
The sentence “You can see the environment you are working in at the top left of the home page when signed in.” is clear and informative.
Tags:
26-26: Clear Guidance for Developer Testing
The instruction advising developers to test configurations in a non-production environment before replicating in production is clear and appropriately detailed.
Tags:
36-42: Well-Structured Section on Managing Environments
The heading “## View and manage environments” and its associated bullet points provide clear, concise instructions. The structure and content effectively guide the user.
Tags:
43-49: Clear and Sequential Steps for Adding an Environment
The “## Add an environment” section lists the steps in a logical order. The instructions are clear and helpful for users adding non-production environments.
Tags:
51-53: Concise Instructions for Switching Environments
The section “## Switch between environments” clearly explains how to change the active environment via the drop-down. No changes needed.
Tags:
55-59: Straightforward Steps for Renaming an Environment
The “## Change the name of an environment” section provides simple, clear, step-by-step instructions for renaming an environment.
Tags:
| ## Change your sign in name | ||
|
|
||
| 1. In Kinde, go to the top right corner and select your avatar. | ||
| 1. In Kinde, go to the bottom-left of screen and select your avatar. |
There was a problem hiding this comment.
@clairekinde11 not sure if we want to mention but this is now only possible from the Home page. Same as Business and Env switching, only lives on Home.
There was a problem hiding this comment.
@clairekinde11 I'm unsure if we have anything in the docs on the "Upgrade to Pro" CTA, but that also only resides on the homepage now, which is this point here.
There's also this change, which is a notable difference. However, I don't know if we mention that anywhere in the docs.
There was a problem hiding this comment.
Thanks @DaveOrDead I'll update to say "On the home page in Kinde, ...."
Thanks @chris-pearce The upgrade topic is still correct, so no change required on point one. On second point, I would usually only say 'Select Save'. There could be a couple of places where I say "scroll down the page and Save. " but I could not find these from searching. I will fix if I see one.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/content/docs/manage-your-account/business-information/update-your-details.mdx (1)
20-23: Improve clarity in navigation instructions.The updated step clearly directs users to select their avatar from the bottom-left of the screen—this change is consistent with the navigation updates in other documentation pages. A small language improvement is recommended: change “bottom-left of screen” to “bottom-left of the screen” for improved clarity.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...nde home page, go to the bottom-left of screen and select your avatar. 2. In the menu ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/content/docs/manage-your-account/business-information/update-your-details.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/content/docs/manage-your-account/business-information/update-your-details.mdx
[uncategorized] ~20-~20: You might be missing the article “the” here.
Context: ...nde home page, go to the bottom-left of screen and select your avatar. 2. In the menu ...
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
3 participants
Updates to:
Manage environments topic (inc. Create new, switch between ,etc.)
Manage businesses topic (inc. Create new, switch between ,etc.)
Update profile name
A couple of minor fixes to get started topics, and a bit of topic cleanup as they were reviewed.
Summary by CodeRabbit