Conversation
Updated signing up as a mentor file, changed to left panel instead of application menu
Added docs for my connections, requests and messages under mentee and mentor sections
Added and updated docs for mentor 3.2
Updated mentor directory and viewchatmessages docs
Updated mentees connection doc
Edited mentorconnections doc
Updated mentor directory, mentor request and mentor connections doc
Edited mentor requests and menteeconnections doc
Updated mentee request, connections, and messages docs and also mentor-directory
Updated the screens for creating profile doc under mentor application
Updated mentee and mentor profile docs
Edited mentor request and mentor connections docs
corrected the typo error for mentor request doc
Updated mentor request doc
Edited mentor request and mentor connections docs
Updated screenshots for mentordirectory and sessionmanager dashboard
Updated mentor request doc
Updated mentorconnections doc
Updated mentor doc and upcomingsession image
Edited sidebars and menteesconnection doc
Updated mentee and mentorconnections doc
Resized sesionrequest and addlink images
Edited mentor directory doc
Created document structure and added sections for User Services
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
📝 WalkthroughWalkthroughThis PR adds a new User Services docs plugin, broadens and reorganizes versioned (3.1) documentation, and updates many docs to use desktop left-panel / mobile burger-menu navigation; it also adds numerous mentor/mentee guidance pages and sidebar entries. Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~35 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). 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}
| <li>Open <PartialExample mentored /> and select <b>Login</b>.</li> | ||
| <li>Enter your <b>Email</b> and <b>Password</b>.</li> | ||
| <Admonition type="note"> | ||
| <p>Enter the correct email ID and password to access the Home page. Passwords are case-sensitive.</p> | ||
| </Admonition> | ||
| <li>Complete the <b>reCAPTCHA</b> verification if required.</li> |
There was a problem hiding this comment.
Invalid list structure: bare
- /
- ; relocate Admonition inside a list item.
Wrap steps in an ordered list; keep the note within the relevant step.
Apply this diff:
-<li>Open <PartialExample mentored /> and select <b>Login</b>.</li>
-<li>Enter your <b>Email</b> and <b>Password</b>.</li>
- <Admonition type="note">
- <p>Enter the correct email ID and password to access the Home page. Passwords are case-sensitive.</p>
- </Admonition>
-<li>Complete the <b>reCAPTCHA</b> verification if required.</li>
+<ol>
+ <li>Open <PartialExample mentored /> and select <b>Login</b>.</li>
+ <li>
+ Enter your <b>email</b> and <b>password</b>.
+ <Admonition type="note">
+ Passwords are case-sensitive. Ensure your email and password are correct to access the Home page.
+ </Admonition>
+ </li>
+ <li>Complete the <b>reCAPTCHA</b> verification if required.</li>
+</ol>📝 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.
| <li>Open <PartialExample mentored /> and select <b>Login</b>.</li> | |
| <li>Enter your <b>Email</b> and <b>Password</b>.</li> | |
| <Admonition type="note"> | |
| <p>Enter the correct email ID and password to access the Home page. Passwords are case-sensitive.</p> | |
| </Admonition> | |
| <li>Complete the <b>reCAPTCHA</b> verification if required.</li> | |
| <ol> | |
| <li>Open <PartialExample mentored /> and select <b>Login</b>.</li> | |
| <li> | |
| Enter your <b>email</b> and <b>password</b>. | |
| <Admonition type="note"> | |
| Passwords are case-sensitive. Ensure your email and password are correct to access the Home page. | |
| </Admonition> | |
| </li> | |
| <li>Complete the <b>reCAPTCHA</b> verification if required.</li> | |
| </ol> |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/_login.mdx around lines 4 to 9 the
file contains bare <li> elements and an Admonition sitting between list items,
which invalidates Markdown/HTML structure; wrap the steps in an ordered list
(<ol>) and move the Admonition inside the appropriate list item (e.g., inside
the step that mentions entering Email and Password) so the note becomes part of
that <li>, ensuring proper opening and closing of the <ol> and preserving the
admonition markup and content.
| @@ -0,0 +1 @@ | |||
| <span>{props.mentored="Mentor"}</span> No newline at end of file | |||
There was a problem hiding this comment.
Bug: mutating props in render; incorrect MDX/JSX expression.
{props.mentored="Mentor"} assigns to props and always renders "Mentor". Use a component with a boolean prop and render conditionally.
Apply this diff:
-<span>{props.mentored="Mentor"}</span>
+export default function PartialExample({ mentored }) {
+ return <span>{mentored ? 'Mentor' : 'Mentee'}</span>;
+}📝 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.
| <span>{props.mentored="Mentor"}</span> | |
| export default function PartialExample({ mentored }) { | |
| return <span>{mentored ? 'Mentor' : 'Mentee'}</span>; | |
| } |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/_mentored.mdx around line 1, the
MDX is mutating props with the invalid expression {props.mentored="Mentor"};
replace this with a proper component usage and conditional rendering: create/use
a component (e.g., <Mentored mentored={props.mentored} /> or wrap inline JSX)
that accepts a boolean prop and renders "Mentor" only when props.mentored is
truthy, or use {props.mentored ? 'Mentor' : null} to render conditionally
without assigning to props.
| 1. On the Login page, click the <b>Forgot password</b> link. | ||
| 2. Enter your <b>Email</b> and the new password. | ||
| 3. Click <b>Validate OTP</b>. | ||
| 4. Complete the <b>reCAPTCHA</b> verification if required. | ||
| 5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID. | ||
| 7. Enter the OTP. | ||
| <p> | ||
| <Admonition type="tip"> | ||
| <p>To receive a new OTP, click the <b>Resend OTP</b> link.</p> | ||
| </Admonition> | ||
| </p> | ||
| 8. Click <b>Verify and login</b> to log in to the Home page. |
There was a problem hiding this comment.
Fix step order/numbering and wording in Reset Password flow.
The current sequence validates OTP before generating/entering it and skips step 6. Reorder and rely on Markdown auto-numbering.
-1. On the Login page, click the <b>Forgot password</b> link.
-2. Enter your <b>Email</b> and the new password.
-3. Click <b>Validate OTP</b>.
-4. Complete the <b>reCAPTCHA</b> verification if required.
-5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID.
-7. Enter the OTP.
- <p>
- <Admonition type="tip">
- <p>To receive a new OTP, click the <b>Resend OTP</b> link.</p>
- </Admonition>
- </p>
-8. Click <b>Verify and login</b> to log in to the Home page.
+1. On the Login page, click <b>Forgot password</b>.
+1. Enter your <b>Email</b> and the new password.
+1. Complete the <b>reCAPTCHA</b> verification if required.
+1. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID.
+1. Enter the OTP.
+ <Admonition type="tip">
+ <p>To receive a new OTP, click the <b>Resend OTP</b> link.</p>
+ </Admonition>
+1. Click <b>Validate OTP</b>.
+1. Click <b>Verify and Log in</b> to go to the Home page.📝 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. On the Login page, click the <b>Forgot password</b> link. | |
| 2. Enter your <b>Email</b> and the new password. | |
| 3. Click <b>Validate OTP</b>. | |
| 4. Complete the <b>reCAPTCHA</b> verification if required. | |
| 5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID. | |
| 7. Enter the OTP. | |
| <p> | |
| <Admonition type="tip"> | |
| <p>To receive a new OTP, click the <b>Resend OTP</b> link.</p> | |
| </Admonition> | |
| </p> | |
| 8. Click <b>Verify and login</b> to log in to the Home page. | |
| 1. On the Login page, click the <b>Forgot password</b>. | |
| 1. Enter your <b>Email</b> and the new password. | |
| 1. Complete the <b>reCAPTCHA</b> verification if required. | |
| 1. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID. | |
| 1. Enter the OTP. | |
| <Admonition type="tip"> | |
| <p>To receive a new OTP, click the <b>Resend OTP</b> link.</p> | |
| </Admonition> | |
| 1. Click <b>Validate OTP</b>. | |
| 1. Click <b>Verify and Log in</b> to go to the Home page. |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/_resetpassword.mdx around lines 5
to 16, the numbered steps are out of order (OTP is validated before it's
generated), step 6 is missing, and there are raw HTML tags; reorder the flow to:
Forgot password -> enter Email and new password -> Generate OTP -> complete
reCAPTCHA if required -> OTP sent -> enter OTP -> Validate OTP -> Verify and
login, remove the explicit hard-coded numbers and stray <p> tags so Markdown
auto-numbering is used, and keep the Tip/Admonition but ensure it's correctly
placed and formatted in MD so "Resend OTP" tip appears between entering the OTP
and validating it.
| * <b>Name</b> | ||
| * <b>Email</b> | ||
| <p> | ||
| <Admonition type="note"> | ||
| <p>Enter a valid email ID.</p> | ||
| </Admonition> | ||
| </p> | ||
| * <b>Password</b> | ||
|
|
||
| 3. Click <b>Validate OTP</b>. | ||
|
|
||
| 4. Complete the <b>reCAPTCHA</b> verification if required. | ||
|
|
||
| 5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID. | ||
|
|
||
| 6. Enter the OTP. | ||
| <p> | ||
| <Admonition type="tip"> | ||
| <p>To receive a new OTP, click <b>Resend OTP</b>.</p> | ||
| </Admonition> | ||
| </p> | ||
|
|
||
| 7. Do the following actions: | ||
|
|
||
| * To read the privacy policy, click the <b>Privacy Policy</b> link. | ||
| * To read the terms of service, click the <b>Terms of Service</b> link. | ||
|
|
||
| 8. Select the checkbox to agree to the terms of service and policy settings. | ||
|
|
||
| 9. Click <b>Verify and login</b>. | ||
|
|
||
| 10. To access the Home page and other features, create your profile. No newline at end of file |
There was a problem hiding this comment.
OTP flow ordering is incorrect; fix sequence and copy.
Users must generate an OTP before validating it. Also prefer “email address” and “log in.”
-2. Enter your details:
-
- * <b>Name</b>
- * <b>Email</b>
- <p>
- <Admonition type="note">
- <p>Enter a valid email ID.</p>
- </Admonition>
- </p>
- * <b>Password</b>
-
-3. Click <b>Validate OTP</b>.
-
-4. Complete the <b>reCAPTCHA</b> verification if required.
-
-5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID.
-
-6. Enter the OTP.
+2. Enter your details:
+
+ * <b>Name</b>
+ * <b>Email address</b>
+ <Admonition type="note">Enter a valid email address.</Admonition>
+ * <b>Password</b>
+
+3. Complete the <b>reCAPTCHA</b> verification if required.
+
+4. Click <b>Generate OTP</b>. An OTP is sent to your registered email address.
+
+5. Enter the OTP.
+
+6. Click <b>Validate OTP</b>.
@@
-7. Do the following actions:
+7. Do the following:
@@
-9. Click <b>Verify and login</b>.
+9. Click <b>Verify and log in</b>.📝 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.
| * <b>Name</b> | |
| * <b>Email</b> | |
| <p> | |
| <Admonition type="note"> | |
| <p>Enter a valid email ID.</p> | |
| </Admonition> | |
| </p> | |
| * <b>Password</b> | |
| 3. Click <b>Validate OTP</b>. | |
| 4. Complete the <b>reCAPTCHA</b> verification if required. | |
| 5. Click <b>Generate OTP</b>. An OTP is sent to your registered email ID. | |
| 6. Enter the OTP. | |
| <p> | |
| <Admonition type="tip"> | |
| <p>To receive a new OTP, click <b>Resend OTP</b>.</p> | |
| </Admonition> | |
| </p> | |
| 7. Do the following actions: | |
| * To read the privacy policy, click the <b>Privacy Policy</b> link. | |
| * To read the terms of service, click the <b>Terms of Service</b> link. | |
| 8. Select the checkbox to agree to the terms of service and policy settings. | |
| 9. Click <b>Verify and login</b>. | |
| 10. To access the Home page and other features, create your profile. | |
| 2. Enter your details: | |
| * <b>Name</b> | |
| * <b>Email address</b> | |
| <Admonition type="note">Enter a valid email address.</Admonition> | |
| * <b>Password</b> | |
| 3. Complete the <b>reCAPTCHA</b> verification if required. | |
| 4. Click <b>Generate OTP</b>. An OTP is sent to your registered email address. | |
| 5. Enter the OTP. | |
| <p> | |
| <Admonition type="tip"> | |
| <p>To receive a new OTP, click <b>Resend OTP</b>.</p> | |
| </Admonition> | |
| </p> | |
| 6. Click <b>Validate OTP</b>. | |
| 7. Do the following: | |
| * To read the privacy policy, click the <b>Privacy Policy</b> link. | |
| * To read the terms of service, click the <b>Terms of Service</b> link. | |
| 8. Select the checkbox to agree to the terms of service and policy settings. | |
| 9. Click <b>Verify and log in</b>. | |
| 10. To access the Home page and other features, create your profile. |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/_signup.mdx around lines 8 to 39,
the OTP step order and wording are wrong: move the "Generate OTP" step before
any "Validate/Enter OTP" step, update copy to use "email address" instead of
"email", change "log in" to "log in" (as two words) and "Verify and login" to
"Verify and log in", and ensure the "Resend OTP" tip appears after the OTP is
generated; also make the step that asks the user to input the code explicit as
"Enter OTP" or "Enter the OTP sent to your email address" and keep reCAPTCHA
step immediately before generating the OTP if applicable.
| @@ -0,0 +1 @@ | |||
| <span>{props.version="2.5"}</span> No newline at end of file | |||
There was a problem hiding this comment.
❓ Verification inconclusive
Version mismatch: shows “2.5” under version-3.1.
Likely a copy/paste; this will confuse users and search.
Apply:
-<span>{props.version="2.5"}</span>
+<span>3.1</span>(Also consider avoiding props mutation as noted elsewhere.)
Version mismatch: shows "2.5" under version-3.1 — remove props mutation.
File: src/docusaurus/versioned_docs/version-3.1/_version.mdx line 1.
-<span>{props.version="2.5"}</span>
+<span>3.1</span>Avoid assigning to props (do not use props.version = ...).
📝 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.
| <span>{props.version="2.5"}</span> | |
| <span>3.1</span> |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/_version.mdx around line 1, remove
the invalid mutation props.version="2.5" (do not assign to props); delete that
line and either remove any programmatic props mutation entirely or replace it
with static/metadata that reflects the correct version (e.g., update frontmatter
or plain content to "3.1") so the file no longer mutates props and shows the
correct version.
| <li>Do one of the following actions:</li> | ||
| <ul> | ||
| <li>Select <b>Help</b> from the <b>Application</b> menu.</li> | ||
| <li>Go to the <b>Application</b> menu <img src={BurgerMenu}/> and select <b>Help</b>.</li> | ||
| </ul> |
There was a problem hiding this comment.
Switch “Application menu” to “left panel” per PR objective; remove burger icon if obsolete.
-<li>Select <b>Help</b> from the <b>Application</b> menu.</li>
-<li>Go to the <b>Application</b> menu <img src={BurgerMenu}/> and select <b>Help</b>.</li>
+<li>In the left panel, select <b>Help</b>.</li>📝 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.
| <li>Do one of the following actions:</li> | |
| <ul> | |
| <li>Select <b>Help</b> from the <b>Application</b> menu.</li> | |
| <li>Go to the <b>Application</b> menu <img src={BurgerMenu}/> and select <b>Help</b>.</li> | |
| </ul> | |
| <li>Do one of the following actions:</li> | |
| <ul> | |
| <li>In the left panel, select <b>Help</b>.</li> | |
| </ul> |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/mentor-deleteaccountrequest.mdx
around lines 22 to 26, the doc uses the phrase "Application menu" and includes a
burger icon; update those references to "left panel" and remove the burger icon
reference if it's obsolete—replace "Select Help from the Application menu." with
"Select Help from the left panel." and change the alternate list item to "Go to
the left panel and select Help." ensuring any <img src={BurgerMenu}/> markup is
removed and the wording matches the PR objective.
| <table> | ||
| <tr> | ||
| <th>Types of Policies</th> | ||
| <th>Description</th> | ||
| </tr> | ||
| <tr> | ||
| <td>All</td> | ||
| <td><p>If the policy is set to <b>All</b>, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations.</p><p><Admonition type="note"><p>Restrictions set by other organizations will be applicable for users.</p></Admonition></p></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Current</td> | ||
| <td><p>If the policy is set to <b>Current</b>, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations.</p></td> | ||
| </tr> | ||
| <tr> | ||
| <td>Associated</td> | ||
| <td><p>The <b>Associated</b> policy provides users with access to mentors, mentees, or sessions across multiple organizations.</p><p>For example, if organizations A and B are linked with the <b>Associated</b> policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations.</p></td> | ||
| </tr> | ||
| </table> |
There was a problem hiding this comment.
MDX components inside raw HTML table cells will not render.
within causes MDX parsing issues and can break the build. Use a Markdown table and move notes outside.
-<table>
- <tr>
- <th>Types of Policies</th>
- <th>Description</th>
- </tr>
- <tr>
- <td>All</td>
- <td><p>If the policy is set to <b>All</b>, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations.</p><p><Admonition type="note"><p>Restrictions set by other organizations will be applicable for users.</p></Admonition></p></td>
- </tr>
- <tr>
- <td>Current</td>
- <td><p>If the policy is set to <b>Current</b>, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations.</p></td>
- </tr>
- <tr>
- <td>Associated</td>
- <td><p>The <b>Associated</b> policy provides users with access to mentors, mentees, or sessions across multiple organizations.</p><p>For example, if organizations A and B are linked with the <b>Associated</b> policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations.</p></td>
- </tr>
-</table>
+| Types of Policies | Description |
+| --- | --- |
+| All | If the policy is set to <b>All</b>, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations. |
+| Current | If the policy is set to <b>Current</b>, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations. |
+| Associated | The <b>Associated</b> policy provides users with access to mentors, mentees, or sessions across multiple organizations. For example, if organizations A and B are linked with the <b>Associated</b> policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations. |
+
+<Admonition type="note">Restrictions set by other organizations will also apply to your users.</Admonition>📝 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.
| <table> | |
| <tr> | |
| <th>Types of Policies</th> | |
| <th>Description</th> | |
| </tr> | |
| <tr> | |
| <td>All</td> | |
| <td><p>If the policy is set to <b>All</b>, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations.</p><p><Admonition type="note"><p>Restrictions set by other organizations will be applicable for users.</p></Admonition></p></td> | |
| </tr> | |
| <tr> | |
| <td>Current</td> | |
| <td><p>If the policy is set to <b>Current</b>, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations.</p></td> | |
| </tr> | |
| <tr> | |
| <td>Associated</td> | |
| <td><p>The <b>Associated</b> policy provides users with access to mentors, mentees, or sessions across multiple organizations.</p><p>For example, if organizations A and B are linked with the <b>Associated</b> policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations.</p></td> | |
| </tr> | |
| </table> | |
| | Types of Policies | Description | | |
| | --- | --- | | |
| | All | If the policy is set to <b>All</b>, the organization’s mentees, mentors, or sessions can be accessed by other organizations. Similarly, the organization’s users can access mentees, mentors, or sessions of other organizations. | | |
| | Current | If the policy is set to <b>Current</b>, only users belonging to the organization can access the mentors, mentees, or sessions. Similarly, the organization’s users cannot access mentees, mentors, or sessions of other organizations. | | |
| | Associated | The <b>Associated</b> policy provides users with access to mentors, mentees, or sessions across multiple organizations. For example, if organizations A and B are linked with the <b>Associated</b> policy, only users belonging to these two organizations can access the mentors, mentees, or sessions of both organizations. | | |
| <Admonition type="note">Restrictions set by other organizations will also apply to your users.</Admonition> |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/policyarchitecture.mdx around lines
28 to 45, the MDX <Admonition> inside an HTML <td> will not render and can break
the build; convert the HTML table to a Markdown table (use pipe-separated header
and rows) and remove the Admonition from inside the table cell, then place the
note as a separate Admonition block immediately after the table (or inline as
plain text inside the cell) so MDX components render correctly.
| 1. Do one of the following actions: | ||
| * Select **Help videos** from the **Application** menu. | ||
| * Go to the **Application** menu  and select **Help videos**. | ||
|
|
||
| 2. Click the appropriate tile to play the video instructions. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
🧩 Analysis chain
Update navigation to “Left panel” per PR objective; remove “Application menu.”
This page still instructs users to use the Application menu, conflicting with the PR’s stated change.
Apply:
-1. Do one of the following actions:
- * Select **Help videos** from the **Application** menu.
- * Go to the **Application** menu  and select **Help videos**.
+1. In the **left panel**, select **Help videos**.If mobile still uses a burger icon, add an “On mobile” note instead of mixing terms in the main flow.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
echo "PWD: $(pwd)"
echo "---- check file path ----"
FILE="src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx"
if [ -f "$FILE" ]; then
echo "FOUND: $FILE"
echo "---- head (1-120) ----"
sed -n '1,120p' "$FILE" || true
else
echo "FILE NOT FOUND: $FILE"
echo "Searching for view-helpvideos.mdx..."
find . -type f -iname "view-helpvideos.mdx" -print -exec sed -n '1,120p' {} \; || true
fi
echo "---- grep for 'Application menu' ----"
grep -nR "Application menu" -n src || true
echo "---- grep for 'Help videos' ----"
grep -nR "Help videos" -n src || trueLength of output: 4475
Replace "Application menu" with "left panel" in Help Videos docs
This page still instructs users to use the "Application menu" — update it here and in all other docs that reference the same wording.
Files to update:
- src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx
- src/docusaurus/docs/view-helpvideos.mdx
- src/docusaurus/docs/faq.mdx
- src/docusaurus/docs/using-the-application.mdx
- src/docusaurus/versioned_docs/version-3.0/view-helpvideos.mdx
- src/docusaurus/versioned_docs/version-2.6/view-helpvideos.mdx
- src/docusaurus/versioned_docs/version-2.5/view-helpvideos.mdx
- (also update the corresponding FAQ and "using-the-application" files under each affected version)
Apply:
-1. Do one of the following actions:
- * Select **Help videos** from the **Application** menu.
- * Go to the **Application** menu  and select **Help videos**.
+1. In the **left panel**, select **Help videos**.If mobile still uses a burger icon, add an "On mobile" note rather than mixing terms.
📝 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. Do one of the following actions: | |
| * Select **Help videos** from the **Application** menu. | |
| * Go to the **Application** menu  and select **Help videos**. | |
| 2. Click the appropriate tile to play the video instructions. | |
| 1. In the **left panel**, select **Help videos**. | |
| 2. Click the appropriate tile to play the video instructions. |
🤖 Prompt for AI Agents
In src/docusaurus/versioned_docs/version-3.1/view-helpvideos.mdx lines 7-11,
replace the phrase "Application menu" with "left panel" in both bullet points
and ensure the burger menu image caption or alt text clarifies that it’s the
left panel on desktop; update the other listed files
(src/docusaurus/docs/view-helpvideos.mdx, src/docusaurus/docs/faq.mdx,
src/docusaurus/docs/using-the-application.mdx,
src/docusaurus/versioned_docs/version-3.0/view-helpvideos.mdx,
src/docusaurus/versioned_docs/version-2.6/view-helpvideos.mdx,
src/docusaurus/versioned_docs/version-2.5/view-helpvideos.mdx and any
corresponding FAQ and using-the-application files in each affected version) with
the same replacement, and if mobile still uses a burger icon add a succinct "On
mobile" note explaining users should tap the burger icon to open the left panel
rather than mixing terminology.
| { | ||
| "tutorialSidebar": [ | ||
| { | ||
| "type": "category", | ||
| "label": "Getting Started", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "intro", | ||
| "label": "Introduction" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "technicalarchitecture", | ||
| "label": "Architecture" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "key-capabilities", | ||
| "label": "Key Capabilities" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "settingup-overview", | ||
| "label": "Hosting and Customizing Your Instance" | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Setting up Organizational Rules and Policies", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "policyarchitecture", | ||
| "label": "About Organizational Rules and Policies" | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "API Reference", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "api-overview", | ||
| "label": "Overview" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "api-setpolicies", | ||
| "label": "Set Policies for Organizations" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "api-setrules", | ||
| "label": "Set Rules for Mentor and Session Discovery" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "api-entitytypeandentity", | ||
| "label": "Create Entity Types and Entities" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Using the Application", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "using-the-application", | ||
| "label": "About the Application" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "gettingstarted", | ||
| "label": "Getting Started with the Application" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "typesofsessions", | ||
| "label": "Types of Sessions" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "notifications", | ||
| "label": "Notifications" | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Managing Users for an Organization", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "aboutorganizationadministrator", | ||
| "label": "Organization Administrator" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "bulkupload", | ||
| "label": "Uploading Users to the Application" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "managementorrequests", | ||
| "label": "Managing Requests to Become a Mentor" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Managing Sessions for an Organization", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "aboutsessionmanager", | ||
| "label": "Session Manager" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "createsession-sessionmanager", | ||
| "label": "Creating Sessions for an Organization" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "manageassignedsession", | ||
| "label": "Managing Sessions Assigned to Mentors" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "joinassignedsession", | ||
| "label": "Joining Sessions Assigned to Mentors" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "dashboard-for-sm", | ||
| "label": "Dashboard" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "How Mentors Can Use the Application", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "signing-up-as-a-mentor", | ||
| "label": "Signing up as a Mentor" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "logging-in-mentor", | ||
| "label": "Logging in" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "creating-and-managing-mentor-profile", | ||
| "label": "Creating a Profile" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "setting-up-a-session", | ||
| "label": "Setting up a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "inviting-mentorsandmentees-host", | ||
| "label": "Promoting Your Public Sessions" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "starting-a-session", | ||
| "label": "Starting a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "dashboard-for-mentors", | ||
| "label": "Dashboard" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "feedbackformentors", | ||
| "label": "Providing Feedback on a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "mentor-deleteaccountrequest", | ||
| "label": "Deleting the Account" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "How Mentees Can Use the Application", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "signing-up-as-a-mentee", | ||
| "label": "Signing up as a Mentee" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "logging-in-mentee", | ||
| "label": "Logging in" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "creating-and-managing-mentee-profile", | ||
| "label": "Creating a Profile" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "request-beamentor", | ||
| "label": "Requesting to Become a Mentor" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "mentor-directory", | ||
| "label": "Using the Mentor Directory" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "viewmentorprofilelink", | ||
| "label": "Using a Shared Link to View a Mentor Profile" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "enrolling-for-a-session", | ||
| "label": "Enrolling for a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "inviting-mentorsandmentees-participants", | ||
| "label": "Promoting Public Sessions with Your Contacts" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "joining-a-session", | ||
| "label": "Joining a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "joining-sessions-using-a-shared-link", | ||
| "label": "Using a Shared Link to Join a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "dashboard-for-mentees", | ||
| "label": "Dashboard" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "feedbackformentees", | ||
| "label": "Providing Feedback on a Session" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "mentee-deleteaccountrequest", | ||
| "label": "Deleting the Account" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "change-language", | ||
| "label": "Changing the Language Settings" | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Support", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "report-signuporloginissue", | ||
| "label": "Reporting Sign up and Log in Issues" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "report-an-issue", | ||
| "label": "Reporting an Issue" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "using-faq", | ||
| "label": "Using the FAQ Page" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "view-helpvideos", | ||
| "label": "Viewing the Help Videos" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Account Security", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "accountloginactivity", | ||
| "label": "Viewing the Account Login Activity" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "changepassword", | ||
| "label": "Changing the Account Password" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "faq", | ||
| "label": "FAQs" | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Troubleshooting", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "bulkupload-invalidsession", | ||
| "label": "Invalid Sessions During Bulk Upload" | ||
| } | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "category", | ||
| "label": "Additional Technical Resources", | ||
| "items": [ | ||
| { | ||
| "type": "doc", | ||
| "id": "apidocumentation", | ||
| "label": "API Documentation" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "databasedesign", | ||
| "label": "Database Design" | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "repos", | ||
| "label": "Source Code Repositories" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "type": "doc", | ||
| "id": "discussions", | ||
| "label": "Discussions" | ||
| } | ||
| ] | ||
| } |
There was a problem hiding this comment.
🧩 Analysis chain
Verify all doc IDs and assets resolve; update UI term per PR goal.
Given the PR objective (switch references from “Application menu” to “left panel”), ensure affected docs—especially signing-up-as-a-mentor—reflect the new term, and that every id here maps to an existing MDX doc in version-3.1. Also verify media/component imports referenced by those docs exist.
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# 1) List all doc IDs from the 3.1 sidebar
jq -r '..|objects|select(has("type") and .type=="doc")|.id' \
src/docusaurus/versioned_sidebars/version-3.1-sidebars.json | sort -u | tee /tmp/ids.txt
echo "---- Checking that each ID has a corresponding doc file or frontmatter id ----"
while read -r id; do
# Check by filename
if fd -a --glob "src/docusaurus/versioned_docs/version-3.1/${id}.mdx" | grep -q .; then
echo "OK (file): $id"
continue
fi
# Check by frontmatter id within 3.1 docs
if rg -nP "^---\\s*\\nid:\\s*${id}\\b" src/docusaurus/versioned_docs/version-3.1 --type=mdx -n | grep -q .; then
echo "OK (frontmatter id): $id"
else
echo "MISSING: $id"
fi
done </tmp/ids.txt
echo "---- Check images/components used by 3.1 docs actually exist ----"
rg -nP "^import\\s+\\w+\\s+from\\s+'\\./media/([^']+)'\\s*;?" src/docusaurus/versioned_docs/version-3.1 --type=mdx -n | \
sed -E "s#^(.+):.+'\\./media/([^']+)'.*#\\1|\\2#g" | while IFS='|' read -r file img; do
path="$(dirname "$file")/media/$img"
if [ -f "$path" ]; then echo "OK media: $path"; else echo "MISSING media: $path"; fi
done
echo "---- Check for <img> without alt, and empty Markdown images ![]() ----"
rg -nP '<img\s+[^>]*src=\{[^}]+\}(?:(?!alt=).)*>' src/docusaurus/versioned_docs/version-3.1 --type=mdx
rg -nP '!\[\]\([^)]+\)' src/docusaurus/versioned_docs/version-3.1 --type=mdx
echo "---- Check Admonition wrongly wrapped in <p> ----"
rg -nP '<p>\s*<Admonition' src/docusaurus/versioned_docs/version-3.1 --type=mdx
rg -nP '</Admonition>\s*</p>' src/docusaurus/versioned_docs/version-3.1 --type=mdx
echo "---- Ensure UI term updated: 'Application menu' -> 'left panel' ----"
rg -nP 'Application\s+menu' src/docusaurus/versioned_docs/version-3.1 --type=mdx -n -C2Length of output: 41
🏁 Script executed:
#!/bin/bash
set -euo pipefail
# Robust re-check that avoids `tee` and external dependencies like `fd`/`rg`.
python3 - <<'PY'
import os, json, re, sys
base = "src/docusaurus"
sidebar = os.path.join(base, "versioned_sidebars", "version-3.1-sidebars.json")
docs_dir = os.path.join(base, "versioned_docs", "version-3.1")
if not os.path.exists(sidebar):
print(f"ERROR: sidebar file not found: {sidebar}", file=sys.stderr)
sys.exit(2)
with open(sidebar, "r", encoding="utf-8") as f:
data = json.load(f)
# Collect doc ids
ids = set()
def walk(obj):
if isinstance(obj, dict):
if obj.get("type") == "doc" and "id" in obj:
ids.add(obj["id"])
for v in obj.values():
walk(v)
elif isinstance(obj, list):
for item in obj:
walk(item)
walk(data)
print("---- Doc IDs found in sidebar ----")
for i in sorted(ids):
print(i)
print("---- Checking that each ID has a corresponding doc file or frontmatter id ----")
# Gather mdx/md files
mdx_files = []
for root, dirs, files in os.walk(docs_dir):
for fname in files:
if fname.lower().endswith((".mdx", ".md")):
mdx_files.append(os.path.join(root, fname))
# Build frontmatter id map
frontmatter_map = {}
for path in mdx_files:
try:
s = open(path, "r", encoding="utf-8").read()
except Exception:
continue
fm = None
stripped = s.lstrip()
if stripped.startswith("---"):
# find closing frontmatter delimiter
matches = [m.start() for m in re.finditer(r"^---\s*$", s, re.MULTILINE)]
if len(matches) >= 2:
start = matches[0]
end = matches[1]
fm = s[start:end]
if fm is None:
# fallback: take first 50 lines
fm = "\n".join(s.splitlines()[:50])
for line in fm.splitlines():
m = re.match(r'^\s*id:\s*["\']?([^"\']+)["\']?\s*$', line)
if m:
key = m.group(1).strip()
frontmatter_map.setdefault(key, []).append(path)
for idd in sorted(ids):
file_path = os.path.join(docs_dir, f"{idd}.mdx")
if os.path.exists(file_path):
print(f"OK (file): {idd}")
elif idd in frontmatter_map:
for p in frontmatter_map[idd]:
print(f"OK (frontmatter id): {idd} -> {p}")
else:
print(f"MISSING: {idd}")
print("---- Check imports from ./media/ referenced in docs ----")
imp_re = re.compile(r"""import\s+[^'"]+\s+from\s+['"]\./media/([^'"]+)['"]""")
for path in mdx_files:
try:
text = open(path, "r", encoding="utf-8").read()
except Exception:
continue
for m in imp_re.finditer(text):
img = m.group(1)
p = os.path.join(os.path.dirname(path), "media", img)
if os.path.exists(p):
print(f"OK media: {p} (in {path})")
else:
print(f"MISSING media: {p} (referenced in {path})")
print("---- Check for <img> without alt and empty Markdown images ![]() ----")
img_tag_re = re.compile(r'<img\s+[^>]*>', re.IGNORECASE)
src_curly_re = re.compile(r'src\s*=\s*\{[^}]+\}')
for path in mdx_files:
try:
with open(path, "r", encoding="utf-8") as f:
for i, line in enumerate(f, start=1):
m = img_tag_re.search(line)
if m:
tag = m.group(0)
if src_curly_re.search(tag) and 'alt=' not in tag:
print(f"{path}:{i}: <img ... src={{...}} missing alt -> {tag.strip()}")
if re.search(r'!\[\]\([^)]+\)', line):
print(f"{path}:{i}: empty markdown image -> {line.strip()}")
except_flag = False
print("---- Check Admonition wrongly wrapped in <p> ----")
for path in mdx_files:
try:
s = open(path, "r", encoding="utf-8").read()
except Exception:
continue
if re.search(r'<p>\s*<Admonition', s, re.IGNORECASE):
print(f"{path}: contains '<p> <Admonition'")
if re.search(r'</Admonition>\s*</p>', s, re.IGNORECASE):
print(f"{path}: contains '</Admonition> </p>'")
print("---- Ensure UI term updated: 'Application menu' -> 'left panel' ----")
pat = re.compile(r'Application\s+menu', re.IGNORECASE)
for path in mdx_files:
try:
with open(path, "r", encoding="utf-8") as f:
for i, line in enumerate(f, start=1):
if pat.search(line):
ctx_before = ""
ctx_after = ""
# show line with context (previous and next if available)
print(f"{path}:{i}: {line.rstrip()}")
except Exception:
continue
PYLength of output: 100
🏁 Script executed:
#!/bin/bash
set -euo pipefail
python3 - <<'PY'
import os, sys, json, re
base = "src/docusaurus"
sidebar_path = os.path.join(base, "versioned_sidebars", "version-3.1-sidebars.json")
docs_dir = os.path.join(base, "versioned_docs", "version-3.1")
if not os.path.exists(sidebar_path):
print(f"ERROR: sidebar file not found: {sidebar_path}", file=sys.stderr)
sys.exit(2)
if not os.path.isdir(docs_dir):
print(f"ERROR: docs dir not found: {docs_dir}", file=sys.stderr)
sys.exit(2)
with open(sidebar_path, "r", encoding="utf-8") as f:
try:
sidebar = json.load(f)
except Exception as e:
print("ERROR: failed to parse sidebar JSON:", e, file=sys.stderr)
sys.exit(2)
ids = set()
def walk(node):
if isinstance(node, dict):
if node.get("type") == "doc" and "id" in node:
ids.add(node["id"])
for v in node.values():
walk(v)
elif isinstance(node, list):
for item in node:
walk(item)
walk(sidebar)
print("---- Doc IDs found in sidebar ----")
for id_ in sorted(ids):
print(id_)
print("---- Checking that each ID has a corresponding doc file or frontmatter id ----")
md_files = []
for root, dirs, files in os.walk(docs_dir):
for fname in files:
if fname.lower().endswith((".md", ".mdx")):
md_files.append(os.path.join(root, fname))
frontmatter_map = {}
fm_delim_re = re.compile(r'^---\s*$', re.M)
id_line_re = re.compile(r'^\s*id:\s*(?:"([^"]+)"|\'([^\']+)\'|(\S+))\s*$', re.I)
for path in md_files:
try:
text = open(path, "r", encoding="utf-8").read()
except Exception:
continue
fm_block = ""
m = fm_delim_re.search(text)
if m:
rest = text[m.end():]
m2 = fm_delim_re.search(rest)
if m2:
fm_block = rest[:m2.start()]
if not fm_block:
fm_block = "\n".join(text.splitlines()[:50])
for line in fm_block.splitlines():
m_id = id_line_re.match(line)
if m_id:
val = m_id.group(1) or m_id.group(2) or m_id.group(3)
frontmatter_map.setdefault(val, []).append(path)
missing_ids = []
for id_ in sorted(ids):
p_mdx = os.path.join(docs_dir, f"{id_}.mdx")
p_md = os.path.join(docs_dir, f"{id_}.md")
if os.path.exists(p_mdx) or os.path.exists(p_md):
print(f"OK (file): {id_}")
elif id_ in frontmatter_map:
for p in frontmatter_map[id_]:
print(f"OK (frontmatter id): {id_} -> {p}")
else:
print(f"MISSING: {id_}")
missing_ids.append(id_)
print("---- Check imports from ./media/ referenced in docs ----")
media_re = re.compile(r"from\s+['\"]\./media/([^'\"]+)['\"]")
missing_media = []
for path in md_files:
try:
text = open(path, "r", encoding="utf-8").read()
except Exception:
continue
for m in media_re.finditer(text):
img = m.group(1)
img_path = os.path.join(os.path.dirname(path), "media", img)
if os.path.exists(img_path):
print(f"OK media: {img_path} (in {path})")
else:
print(f"MISSING media: {img_path} (referenced in {path})")
missing_media.append(img_path)
print("---- Check for <img> without alt and empty Markdown images ![]() ----")
img_tag_re = re.compile(r'<img\s+[^>]*>', re.I)
src_curly_re = re.compile(r'src\s*=\s*\{[^}]+\}')
empty_md_re = re.compile(r'!\[\]\([^)]+\)')
for path in md_files:
try:
lines = open(path, "r", encoding="utf-8").read().splitlines()
except Exception:
continue
for i, line in enumerate(lines, start=1):
m = img_tag_re.search(line)
if m:
tag = m.group(0)
if src_curly_re.search(tag) and 'alt=' not in tag:
print(f"{path}:{i}: <img ... src={{...}} missing alt -> {tag.strip()}")
if empty_md_re.search(line):
print(f"{path}:{i}: empty markdown image -> {line.strip()}")
print("---- Check Admonition wrongly wrapped in <p> ----")
for path in md_files:
try:
text = open(path, "r", encoding="utf-8").read()
except Exception:
continue
for i, line in enumerate(text.splitlines(), start=1):
if re.search(r'<p>\s*<Admonition', line, re.I):
print(f"{path}:{i}: contains '<p> <Admonition'")
if re.search(r'</Admonition>\s*</p>', line, re.I):
print(f"{path}:{i}: contains '</Admonition> </p>'")
print("---- Ensure UI term updated: 'Application menu' -> 'left panel' ----")
app_menu_re = re.compile(r'Application\s+menu', re.I)
for path in md_files:
try:
lines = open(path, "r", encoding="utf-8").read().splitlines()
except Exception:
continue
for i, line in enumerate(lines, start=1):
if app_menu_re.search(line):
prev_line = lines[i-2] if i-2 >= 0 else ""
next_line = lines[i] if i < len(lines) else ""
print(f"{path}:{i}: {prev_line.rstrip()} >>> {line.rstrip()} <<< {next_line.rstrip()}")
print("---- Summary ----")
print(f"Total doc ids in sidebar: {len(ids)}")
print(f"Missing doc ids: {len(missing_ids)}")
print(f"Missing media references: {len(missing_media)}")
PYLength of output: 36369
Action: change “Application menu” → “left panel”; docs & media verified — fix accessibility & Admonition issues
- Sidebar IDs: 56 entries — all map to src/docusaurus/versioned_docs/version-3.1 (no missing docs).
- Media: all ./media imports resolve (no missing assets).
- UI wording: instances of "Application menu" remain (often wrapped in markup). Update wording to "left panel". Examples: src/docusaurus/versioned_docs/version-3.1/createsession-sessionmanager.mdx, src/docusaurus/versioned_docs/version-3.1/mentor-directory.mdx. Check signing-up-as-a-mentor.mdx for related UI text/icons.
- Accessibility: many files use empty image markdown (
) or
without alt — representative files: src/docusaurus/versioned_docs/version-3.1/_joinsessionstep-portal.mdx, createsession-sessionmanager.mdx, aboutorganizationadministrator.mdx, dashboard-for-mentees.mdx, mentor-directory.mdx. Add descriptive alt text / replace empty markdown images.
- Admonitions: remove surrounding
tags in these files: src/docusaurus/versioned_docs/version-3.1/_sessionbulkuploadtable.mdx, src/docusaurus/versioned_docs/version-3.1/api-entitytypeandentity.mdx, src/docusaurus/versioned_docs/version-3.1/policyarchitecture.mdx.
- Re-run the verification script after making these edits.
🤖 Prompt for AI Agents
In src/docusaurus/versioned_sidebars/version-3.1-sidebars.json lines 1-356:
update referenced docs per the review — replace any UI wording "Application
menu" with "left panel" in the identified MDX files (e.g.,
createsession-sessionmanager.mdx, mentor-directory.mdx,
signing-up-as-a-mentor.mdx) by editing markup and text nodes; fix accessibility
by replacing empty image markdown () and <img src={...}> without alt in
the representative files (_joinsessionstep-portal.mdx,
createsession-sessionmanager.mdx, aboutorganizationadministrator.mdx,
dashboard-for-mentees.mdx, mentor-directory.mdx) with descriptive alt attributes
or suitable captions; remove surrounding <p> tags wrapping admonition blocks in
_sessionbulkuploadtable.mdx, api-entitytypeandentity.mdx, and
policyarchitecture.mdx so admonitions are top-level elements; keep sidebar IDs
unchanged (docs exist) and then re-run the verification script to confirm no
missing docs or media.
sentence correction
corrected sentence/grammatical errors
updated intro doc
Updated the documentation structure similar to other Elevate capabilities
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
src/docusaurus/sidebarsUserservices.js (3)
72-77: Unify label style (gerund vs imperative)Other labels use gerunds (e.g., “Registering…”, “Logging in”). Consider aligning “Reset Your Password” to “Resetting Your Password” for consistency.
id: 'resetpwd', - label: 'Reset Your Password', + label: 'Resetting Your Password',
172-175: Capitalize “Workflows”Minor grammar/polish: title case for “Workflows”.
- label: 'Understanding Notification workflows', // sidebar label + label: 'Understanding Notification Workflows', // sidebar label
20-38: Add generated index pages to categories (improves UX and SEO)Consider adding a generated index to categories so users land on a helpful overview when clicking the category.
{ type: 'category', label: 'Getting Started', + link: { type: 'generated-index', description: 'Introduction and key concepts for User Services.' }, items: [Repeat similarly for other categories if desired.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
src/docusaurus/sidebarsUserservices.js(1 hunks)src/docusaurus/userservices/intro.mdx(1 hunks)src/docusaurus/userservices/settingup-overview.mdx(1 hunks)src/docusaurus/userservices/using-the-application.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- src/docusaurus/userservices/using-the-application.mdx
- src/docusaurus/userservices/settingup-overview.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- src/docusaurus/userservices/intro.mdx
🧰 Additional context used
🧬 Code graph analysis (1)
src/docusaurus/sidebarsUserservices.js (1)
src/docusaurus/sidebars.js (1)
sidebars(15-419)
🔇 Additional comments (2)
src/docusaurus/sidebarsUserservices.js (2)
12-15: Type annotations and structure look goodJSDoc typing with SidebarsConfig and the overall CJS export pattern are correct.
15-181: Confirmed: userservices sidebar wired & all doc IDs existsrc/docusaurus/docusaurus.config.js registers the docs plugin with id 'userservices' and sidebarPath require.resolve('./sidebarsUserservices.js'); every doc ID in the sidebar resolved to files (found under src/docusaurus/userservices/*.mdx).
Updated a few docs under Using the Application
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
src/docusaurus/userservices/media/login.pngis excluded by!**/*.png
📒 Files selected for processing (6)
src/docusaurus/docs/mentee-request.mdx(1 hunks)src/docusaurus/sidebarsUserservices.js(1 hunks)src/docusaurus/userservices/login.mdx(1 hunks)src/docusaurus/userservices/profile.mdx(1 hunks)src/docusaurus/userservices/register.mdx(1 hunks)src/docusaurus/userservices/resetpwd.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- src/docusaurus/userservices/profile.mdx
- src/docusaurus/userservices/register.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- src/docusaurus/userservices/login.mdx
- src/docusaurus/docs/mentee-request.mdx
- src/docusaurus/sidebarsUserservices.js
| 1. On the Login page, click the <b>Forgot Password?</b> link. | ||
| 2. Enter your Email or user name or the mobile number. | ||
| 3. Enter the new password. | ||
| 4. Re-enter the new password in the <b>Confirm New Password</b> text box. | ||
| 3. Click <b>Send OTP</b>. An OTP is sent to your registered email ID. | ||
| 4. Enter the OTP to log in to the Home page. |
There was a problem hiding this comment.
Fix the misordered step numbering
The ordered list repeats steps 3 and 4, which breaks the sequence and can confuse readers following the reset flow.
Apply this diff to correct the numbering:
-1. On the Login page, click the <b>Forgot Password?</b> link.
-2. Enter your Email or user name or the mobile number.
-3. Enter the new password.
-4. Re-enter the new password in the <b>Confirm New Password</b> text box.
-3. Click <b>Send OTP</b>. An OTP is sent to your registered email ID.
-4. Enter the OTP to log in to the Home page.
+1. On the Login page, click the <b>Forgot Password?</b> link.
+2. Enter your Email or user name or the mobile number.
+3. Enter the new password.
+4. Re-enter the new password in the <b>Confirm New Password</b> text box.
+5. Click <b>Send OTP</b>. An OTP is sent to your registered email ID.
+6. Enter the OTP to log in to the Home page.📝 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. On the Login page, click the <b>Forgot Password?</b> link. | |
| 2. Enter your Email or user name or the mobile number. | |
| 3. Enter the new password. | |
| 4. Re-enter the new password in the <b>Confirm New Password</b> text box. | |
| 3. Click <b>Send OTP</b>. An OTP is sent to your registered email ID. | |
| 4. Enter the OTP to log in to the Home page. | |
| 1. On the Login page, click the <b>Forgot Password?</b> link. | |
| 2. Enter your Email or user name or the mobile number. | |
| 3. Enter the new password. | |
| 4. Re-enter the new password in the <b>Confirm New Password</b> text box. | |
| 5. Click <b>Send OTP</b>. An OTP is sent to your registered email ID. | |
| 6. Enter the OTP to log in to the Home page. |
🤖 Prompt for AI Agents
In src/docusaurus/userservices/resetpwd.mdx around lines 8 to 13, the ordered
list has duplicate step numbers (two "3." and two "4.") which breaks the flow;
renumber the steps in proper sequence 1–5 so they read: 1) click Forgot
Password, 2) enter email/username/mobile, 3) enter new password, 4) confirm new
password, 5) click Send OTP and then enter OTP to log in — update the markup
accordingly so the list increments correctly.
Updated intro and added key capabilities section
Updated key capabilities doc
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 (2)
src/docusaurus/userservices/abouttenants.mdx(1 hunks)src/docusaurus/userservices/key-capabilities.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/docusaurus/userservices/key-capabilities.mdx
| 2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and | ||
| configuration. | ||
|
|
There was a problem hiding this comment.
Remove unintended code block indentation
The seven leading spaces before “configuration.” turn the second half of the sentence into a fenced code block in the rendered doc, breaking the text flow. Collapse the sentence onto one line (or drop the indentation) so it renders as regular prose.
-2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and
- configuration.
+2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and configuration.📝 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.
| 2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and | |
| configuration. | |
| 2. Multi-tenant architecture: All customers share the same application and database; however each customer will have their own isolated data and configuration. |
🤖 Prompt for AI Agents
In src/docusaurus/userservices/abouttenants.mdx around lines 14 to 16, the
second line of the sentence has seven leading spaces which causes the remainder
to render as a code block; remove the leading spaces and collapse the sentence
onto one line (or otherwise drop indentation) so the full sentence reads as
normal prose without code-block formatting.
Updated the search feature in the mentor directory doc
| <Admonition type="info"> | ||
| <p> | ||
| <ul> | ||
| <li>You can send only one message till your message request is accepted.</li> | ||
| <li>The text message can contain letters, numbers, and special characters.</li> | ||
| <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> | ||
| <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, | ||
| the mentee can send a new message request.</li> | ||
|
|
||
| </ul> | ||
| </p> |
There was a problem hiding this comment.
Remove invalid <p> wrapper around the list.
Wrapping a <ul> inside a <p> produces invalid markup and renders unpredictably. Drop the surrounding <p> tags (or replace them with plain text above the list).
Apply this diff:
-<Admonition type="info">
- <p>
- <ul>
+<Admonition type="info">
+ <ul>
@@
- </ul>
- </p>
+ </ul>
</Admonition>📝 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.
| <Admonition type="info"> | |
| <p> | |
| <ul> | |
| <li>You can send only one message till your message request is accepted.</li> | |
| <li>The text message can contain letters, numbers, and special characters.</li> | |
| <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> | |
| <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, | |
| the mentee can send a new message request.</li> | |
| </ul> | |
| </p> | |
| <Admonition type="info"> | |
| <ul> | |
| <li>You can send only one message till your message request is accepted.</li> | |
| <li>The text message can contain letters, numbers, and special characters.</li> | |
| <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> | |
| <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, | |
| the mentee can send a new message request.</li> | |
| </ul> | |
| </Admonition> |
🤖 Prompt for AI Agents
In src/docusaurus/docs/mentor-directory.mdx around lines 148 to 158, the
unordered list is wrapped in a <p> tag which produces invalid HTML; remove the
surrounding <p> open and close tags so the <ul> sits directly inside the
Admonition (or, if you need a lead sentence, convert the <p> to a plain
paragraph above the <ul>), ensuring no paragraph encloses the list.
| The mentee can request for a session using the **Request session** option. | ||
|
|
||
| **To request a session, do as follows:** | ||
|
|
||
| 1. Click **Request session** on the mentor card. | ||
|
|
||
| 2. Enter a title for the session. | ||
|
|
||
| 3. Set the the start date and the end date using the calendar icon. | ||
|
|
||
| 4. Enter the agenda for the session. | ||
|
|
||
| 5. Click **Submit request**. A message appears stating that your request has been sent successfully. |
There was a problem hiding this comment.
Clean up session request steps.
Two small fixes needed in this block:
- “request for a session” should be “request a session.”
- “Set the the start date...” has a duplicated “the.”
Please adjust accordingly.
🤖 Prompt for AI Agents
In src/docusaurus/docs/mentor-directory.mdx around lines 171 to 183, fix the
wording in the session request steps: change “request for a session” to “request
a session” and remove the duplicated word in “Set the the start date...” so it
reads “Set the start date and the end date using the calendar icon.” Ensure the
corrected phrases replace the originals exactly in that block.
Updated mentor directory and register doc
Updated with feedback comments for my connections, requests and mentor directory
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/docusaurus/docs/starting-a-session.mdx (1)
37-37: Apply the same grammatical correction at line 37.Line 37 contains identical text with the same grammatical error: "go the My mentoring sessions tab." This should be corrected to "go to the" for consistency with line 64.
-<li>On your Home page, go the <b>My mentoring sessions</b> tab.</li> +<li>On your Home page, go to the <b>My mentoring sessions</b> tab.</li>
♻️ Duplicate comments (6)
src/docusaurus/docs/mentor-directory.mdx (4)
6-6: Fix possessive in intro sentence."The mentor directory lists the mentors profiles" should use the possessive form "mentors'" (with apostrophe after mentors).
Apply this diff:
-The mentor directory lists the mentors profiles in an alphabetical order. +The mentor directory lists the mentors' profiles in an alphabetical order.
12-12: Add missing article before "chat request".The sentence reads "Send a chat request or session request to a mentor" but should include the article "a" before "session request" for grammatical consistency.
Apply this diff:
-* Send a chat request or session request to a mentor. +* Send a chat request or a session request to a mentor.
84-84: Add missing article before "session request".Matches the issue at line 12; "Send a chat request or session request" should read "Send a chat request or a session request" for proper grammar.
Apply this diff:
-* Send a chat request or session request to a mentor. +* Send a chat request or a session request to a mentor.
147-157: Remove invalid<p>wrapper around the list.Wrapping a
<ul>inside a<p>produces invalid markup and renders unpredictably. Drop the surrounding<p>tags.Apply this diff:
<Admonition type="info"> - <p> <ul> <li>You can send only one message till your message request is accepted.</li> <li>The text message can contain letters, numbers, and special characters.</li> <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, the mentee can send a new message request.</li> </ul> - </p> </Admonition>src/docusaurus/docs/dashboard-for-sm.mdx (1)
17-27: Same pattern: "Application menu" unchanged despite PR objective.Consistent with the first file, Line 20 retains "Application menu" reference. The image asset was updated from
SessionManagerMenutoPortalApplicationMenu(visual consistency), and a PWA alternative was added—but the stated PR objective of replacing "Application menu" with "left panel" is not reflected.This matches the inconsistency flagged in dashboard-for-mentors.mdx.
src/docusaurus/docs/dashboard-for-mentees.mdx (1)
14-24: Confirm: All three dashboard files follow same unchanged pattern.All three files (mentors, mentees, session managers) maintain "Application menu" references in their navigation instructions, contradicting the PR objective's stated intent. The actual changes are structural reorganizations and PWA support additions, not terminology updates.
This is a continuation of the inconsistency flagged across all three files. Before merging, confirm whether the PR objective accurately describes these changes or whether the "left panel" terminology shift was incomplete.
🧹 Nitpick comments (6)
src/docusaurus/docs/mentorsconnections.mdx (1)
61-61: Minor writing suggestion: Strengthen phrasing.The phrase "To do this, type three or more letters" could be more direct. Consider rephrasing to something like "Type three or more letters of the mentor's name or area of expertise in the search box and press Enter" to reduce redundancy with the preceding sentence.
src/docusaurus/docs/mentor-request.mdx (4)
1-2: Remove unused import statement.The
Admonitioncomponent is imported but never used in the document. Remove this unused import or add appropriate admonitions (e.g., tips, warnings) to the content if needed.-import Admonition from '@theme/Admonition'; -
12-12: Use consistent number formatting.Line 12 uses parenthetical numbering
(1)and(2)for the tab list. This deviates from the numbered list format used in the step-by-step instructions below. For consistency, either convert to a standard numbered list or use the parenthetical format uniformly throughout.-2. There are two tabs: (1) **Session requests** (2) **Message requests** +2. There are two tabs: + 1. **Session requests** + 2. **Message requests**
20-20: Standardize UI element naming across sections.Inconsistent button/action labels create potential confusion:
- Lines 20 and 30: "View details"
- Line 66: "View Message"
Decide on a consistent naming convention (either use "View details" for both request types or find another standard) and apply it uniformly.
Also applies to: 30-30, 66-66
51-56: Expand the "Managing Message Requests" section with descriptive details.This section is significantly briefer than its Session Requests counterpart (lines 14–20). The description at lines 53–54 lacks detail beyond the image. Consider expanding to match the depth of the Session Requests section and provide clearer context about what mentees see and what actions mentors can take.
src/docusaurus/docs/mentor-directory.mdx (1)
10-10: Consider more direct phrasing for clarity.The phrase "To do this, click anywhere on the mentor's card" could be more concise. Consider rephrasing as: "Click anywhere on the mentor's card to view their profile" to reduce redundancy and improve readability.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (3)
src/docusaurus/docs/media/dashboard-icon.pngis excluded by!**/*.pngsrc/docusaurus/docs/media/mentordirectory-icon.PNGis excluded by!**/*.pngsrc/docusaurus/userservices/media/login.pngis excluded by!**/*.png
📒 Files selected for processing (10)
src/docusaurus/docs/creating-and-managing-mentee-profile.mdx(2 hunks)src/docusaurus/docs/creating-and-managing-mentor-profile.mdx(2 hunks)src/docusaurus/docs/dashboard-for-mentees.mdx(1 hunks)src/docusaurus/docs/dashboard-for-mentors.mdx(1 hunks)src/docusaurus/docs/dashboard-for-sm.mdx(1 hunks)src/docusaurus/docs/menteesconnections.mdx(1 hunks)src/docusaurus/docs/mentor-directory.mdx(3 hunks)src/docusaurus/docs/mentor-request.mdx(1 hunks)src/docusaurus/docs/mentorsconnections.mdx(1 hunks)src/docusaurus/docs/starting-a-session.mdx(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
- src/docusaurus/docs/creating-and-managing-mentor-profile.mdx
- src/docusaurus/docs/menteesconnections.mdx
- src/docusaurus/docs/creating-and-managing-mentee-profile.mdx
🧰 Additional context used
🪛 LanguageTool
src/docusaurus/docs/mentor-directory.mdx
[style] ~10-~10: Consider a more expressive alternative.
Context: .... * View all the mentors' profiles. To do this, click anywhere on the mentor's ca...
(DO_ACHIEVE)
src/docusaurus/docs/mentorsconnections.mdx
[style] ~61-~61: Consider a more expressive alternative.
Context: ...tor name** or Area of Expertise. To do this, type three or more letters of the...
(DO_ACHIEVE)
🔇 Additional comments (9)
src/docusaurus/docs/mentorsconnections.mdx (1)
1-86: Scope mismatch between PR objectives and file content.The PR objectives state the intent is to update the "signing up as a mentor" file and replace "Application menu" references with "left panel." However, the provided file is about "My Connections - Mentor" (managing existing connections) rather than signing up, and contains no references to "Application menu" or "left panel" to replace.
Please clarify:
- Is this the correct file for this PR, or were other files modified to address the PR objectives?
- If this is a new documentation page being added, ensure the PR description accurately reflects the scope of changes.
src/docusaurus/docs/mentor-request.mdx (1)
10-10: Good alignment with PR objectives.The documentation correctly uses "left panel" (line 10) rather than "Application menu," aligning well with the PR's stated goal of updating navigation references.
src/docusaurus/docs/starting-a-session.mdx (2)
64-64: Good grammatical correction.The change from "go the" to "go to the" is correct and improves readability.
1-114: File scope appears misaligned with PR objective.The PR objective mentions updating references from "Application menu" to "left panel," but this file contains no such references. Verify whether this file is in scope for the PR changes or if the intended modifications were missed.
src/docusaurus/docs/mentor-directory.mdx (5)
17-17: Left panel reference aligns with PR objective.Updated reference from application menu to left panel is appropriate and directly addresses the PR goal.
29-29: Verify alternative access method is intentional.Line 29 still references "Go to the application and click the Mentors tab" as a PWA alternative. Confirm this secondary access path should retain the application reference (as opposed to a left panel equivalent for PWA).
130-158: New chat request section is well-structured.The new section clearly documents the message request workflow with appropriate constraints (character limits, one-message-at-a-time restriction) and user expectations. Steps are logical and include visual references.
160-165: Message request acceptance/rejection section is clear.Properly documents the mentor's perspective on accepting or rejecting requests and explains the notification workflow to mentees. Content is concise and actionable.
168-182: Session request section follows consistent documentation pattern.Clear step-by-step instructions for session requests with appropriate field labels (title, agenda, dates). Follows the same structural conventions as the chat request section above.
Changes made in the navigation steps for mentor
There was a problem hiding this comment.
Actionable comments posted: 3
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/docusaurus/docs/change-language.mdx (1)
1-3: Remove unusedAdmonitionimport.The
Admonitioncomponent is imported but not used in the document. Remove it to keep imports clean.import BurgerMenu from './media/burgermenu-icon.png' import PortalLanguageSetting from './media/portal-languagesettings.png' -import Admonition from '@theme/Admonition';
♻️ Duplicate comments (1)
src/docusaurus/docs/mentor-directory.mdx (1)
147-158: Remove invalid<p>wrapper around the list (unresolved past comment).A previous review flagged that wrapping a
<ul>inside a<p>produces invalid markup and renders unpredictably. This issue remains unresolved in the current version. Drop the surrounding<p>tags or replace them with plain text above the list.Apply this diff to fix the invalid markup:
<Admonition type="info"> - <p> <ul> <li>You can send only one message till your message request is accepted.</li> <li>The text message can contain letters, numbers, and special characters.</li> <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, the mentee can send a new message request.</li> </ul> - </p> </Admonition>
🧹 Nitpick comments (4)
src/docusaurus/docs/change-language.mdx (1)
11-21: Step-by-step structure aligns well with PR objectives; minor wording refinement suggested.The changes effectively introduce platform-specific guidance (desktop/mobile) and restructure the instructions into clear numbered steps. The desktop left-panel and mobile burger-menu references align well with the PR objective.
Minor note: Line 15 uses "Language" twice in close succession ("Language page" and "Language button"), which may feel repetitive. Consider rewording for conciseness, such as:
click the <b>Language</b> button of your choice.to remove the "page" reference since the context is already clear.-2. On the Language page, click a <b>Language</b> button of your choice. +2. Click a <b>Language</b> button of your choice.src/docusaurus/docs/mentorsconnections.mdx (2)
1-15: Clarify the entry point: how to access "My Connections" from the left panel.The document jumps directly into actions available on the My Connections page but doesn't explain how to navigate to it. Given the PR objective mentions changing navigation from "application menu" to "left panel," consider adding a brief introductory step explaining how to access this page from the left panel on desktop and burger-menu on mobile (as mentioned in the broader PR context). This would provide users with a complete workflow from entry point to action.
Consider adding a subsection like:
## Accessing My Connections To access the My Connections page: 1. On desktop, click **My Connections** in the left panel. 2. On mobile, tap the burger menu icon and select **My Connections**.This ensures the documentation is self-contained and users can follow the full workflow without searching elsewhere.
61-62: Slightly refine search instruction for clarity.The instruction is clear but could be more direct. Consider making the search requirement more prominent.
-You can search either by **Mentor name** or **Area of Expertise**. To do this, type three or more letters of the mentor's name or area of expertise in the search box +You can search by **Mentor name** or **Area of Expertise**. Enter at least three characters of the mentor's name or expertise area in the search box -and then press **Enter**. The search results appear based on the search term you typed. +and press **Enter** to view matching results.This version is more concise and makes the character requirement explicit upfront.
src/docusaurus/docs/mentor-directory.mdx (1)
144-145: Minor grammar improvement needed.Line 144 reads "You will be able to start the conversation through messages only when the mentor accepts the request and a connection is established." The phrase is slightly awkward; consider: "You will be able to start conversations through messages only after the mentor accepts the request and a connection is established." or "Conversations via messages are only possible after the mentor accepts the request and a connection is established."
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (26)
src/docusaurus/docs/aboutorganizationadministrator.mdx(1 hunks)src/docusaurus/docs/aboutsessionmanager.mdx(2 hunks)src/docusaurus/docs/accountloginactivity.mdx(1 hunks)src/docusaurus/docs/bulkupload.mdx(2 hunks)src/docusaurus/docs/change-language.mdx(1 hunks)src/docusaurus/docs/changepassword.mdx(1 hunks)src/docusaurus/docs/createsession-sessionmanager.mdx(4 hunks)src/docusaurus/docs/creating-and-managing-mentee-profile.mdx(3 hunks)src/docusaurus/docs/creating-and-managing-mentor-profile.mdx(3 hunks)src/docusaurus/docs/dashboard-for-mentees.mdx(1 hunks)src/docusaurus/docs/dashboard-for-mentors.mdx(1 hunks)src/docusaurus/docs/dashboard-for-sm.mdx(1 hunks)src/docusaurus/docs/joinassignedsession.mdx(2 hunks)src/docusaurus/docs/manageassignedsession.mdx(4 hunks)src/docusaurus/docs/managementorrequests.mdx(1 hunks)src/docusaurus/docs/mentee-request.mdx(1 hunks)src/docusaurus/docs/menteesconnections.mdx(1 hunks)src/docusaurus/docs/mentor-directory.mdx(3 hunks)src/docusaurus/docs/mentor-request.mdx(1 hunks)src/docusaurus/docs/mentorsconnections.mdx(1 hunks)src/docusaurus/docs/report-an-issue.mdx(1 hunks)src/docusaurus/docs/signing-up-as-a-mentee.mdx(1 hunks)src/docusaurus/docs/signing-up-as-a-mentor.mdx(1 hunks)src/docusaurus/docs/starting-a-session.mdx(2 hunks)src/docusaurus/docs/using-faq.mdx(1 hunks)src/docusaurus/docs/view-helpvideos.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (2)
- src/docusaurus/docs/menteesconnections.mdx
- src/docusaurus/docs/manageassignedsession.mdx
🚧 Files skipped from review as they are similar to previous changes (4)
- src/docusaurus/docs/signing-up-as-a-mentee.mdx
- src/docusaurus/docs/dashboard-for-sm.mdx
- src/docusaurus/docs/creating-and-managing-mentee-profile.mdx
- src/docusaurus/docs/mentor-request.mdx
🧰 Additional context used
🪛 LanguageTool
src/docusaurus/docs/change-language.mdx
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: .../> icon and select Language. 2. On the Language page, click a Language<...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
src/docusaurus/docs/managementorrequests.mdx
[style] ~17-~17: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...on and select Workspace. 2. On the Workspace page, click **Manage user...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
src/docusaurus/docs/mentorsconnections.mdx
[style] ~61-~61: Consider a more expressive alternative.
Context: ...tor name** or Area of Expertise. To do this, type three or more letters of the...
(DO_ACHIEVE)
src/docusaurus/docs/mentor-directory.mdx
[style] ~10-~10: Consider a more expressive alternative.
Context: .... * View all the mentors' profiles. To do this, click anywhere on the mentor's ca...
(DO_ACHIEVE)
🔇 Additional comments (29)
src/docusaurus/docs/starting-a-session.mdx (1)
37-37: Grammatical corrections are appropriate.Both instances correctly add the missing preposition "to" between "go" and "the" for proper English grammar. "Go to the My mentoring sessions tab" reads naturally and is the standard phrasing in instructional documentation.
Also applies to: 64-64
src/docusaurus/docs/aboutorganizationadministrator.mdx (1)
30-37: Device-specific instructions provide clear navigation guidance.The differentiation between desktop (left panel) and mobile (BurgerMenu) logout flows is well-structured and aligns with the PR objectives to replace generic application-menu references with context-aware navigation paths. The instructions are clear and actionable once the alt text concern (flagged separately) is addressed.
src/docusaurus/docs/using-faq.mdx (3)
11-12: Desktop and mobile navigation guidance is clear and user-friendly.The updated instructions provide explicit platform-specific guidance:
- Desktop users are directed to the left panel (consistent with updated navigation model)
- Mobile users see a visual burger menu icon and clear instructions to tap it
The MDX/React inline image syntax for BurgerMenu is correct. This change aligns well with the PR's objective to transition navigation references across documentation.
16-16: Image asset verified and exists.The
portal-faq.pngfile is present atsrc/docusaurus/docs/media/portal-faq.pngand the relative path in the markdown is correct. The image is also properly committed across versioned documentation.
1-1: Asset paths verified and correct.Both image assets are properly committed and the relative paths resolve correctly:
burgermenu-icon.pngexists at./media/burgermenu-icon.png(relative to the file)portal-faq.pngexists at./media/portal-faq.pngThe import and usage syntax are valid MDX/JSX.
src/docusaurus/docs/mentorsconnections.mdx (1)
1-86: All referenced image files are present and correctly located.Verification confirms that all three images referenced in the documentation (mentorconnections.png, mentorsearchfilter.png, mentorfilter.png) exist in the media directory as expected. The documentation references are valid.
src/docusaurus/docs/accountloginactivity.mdx (1)
19-20: Navigation updates align with PR objective.The device-specific guidance (left panel for desktop, BurgerMenu for mobile) follows the consistent pattern established across the documentation and correctly replaces the Application menu reference.
src/docusaurus/docs/aboutsessionmanager.mdx (2)
3-3: BurgerMenu import correctly added.The import is properly placed and follows the pattern used across other documentation files in this PR.
38-40: Logout navigation updated consistently.Device-specific guidance (left panel for desktop, BurgerMenu icon for mobile) is implemented correctly and follows the established navigation pattern.
src/docusaurus/docs/bulkupload.mdx (2)
2-2: BurgerMenu import correctly positioned.The import follows the established pattern and is used in the corresponding mobile navigation section.
22-24: Device-specific workspace navigation implemented correctly.The restructured navigation clearly distinguishes desktop (left panel) and mobile (BurgerMenu) paths, maintaining consistency with the documentation update strategy.
src/docusaurus/docs/view-helpvideos.mdx (2)
1-1: BurgerMenu asset imported correctly.Import placement and syntax follow the established pattern across the documentation updates in this PR.
11-13: Help videos navigation updated to device-specific guidance.Desktop and mobile paths are clearly differentiated, maintaining consistency with the broader navigation documentation updates.
src/docusaurus/docs/report-an-issue.mdx (1)
15-16: Issue reporting navigation properly updated.Device-specific navigation guidance (left panel for desktop, BurgerMenu for mobile) is correctly implemented and follows the consistent pattern across documentation.
src/docusaurus/docs/dashboard-for-mentors.mdx (1)
14-24: Navigation structure properly updated for device-specific access.The restructuring correctly addresses the past review concern by replacing Application menu references with left panel guidance on desktop (line 17). The mobile guidance appropriately directs to the Dashboard tab at the bottom of the screen, which aligns with the actual mobile app navigation structure for mentors.
src/docusaurus/docs/createsession-sessionmanager.mdx (3)
5-5: BurgerMenu import correctly added.The import is properly positioned and will be reused across multiple navigation sections in this file.
23-25: Create Session workspace navigation updated consistently.Device-specific guidance properly distinguishes desktop (left panel) and mobile (BurgerMenu) paths.
241-243: Bulk Upload workspace navigation mirrors Create Session pattern.The consistent device-specific guidance across both sections maintains documentation clarity and alignment with the overall navigation update strategy.
src/docusaurus/docs/joinassignedsession.mdx (2)
5-5: BurgerMenu import correctly added.The import is properly positioned and used in the mobile navigation section of this file.
25-27: Session enrollment navigation properly updated with device-specific guidance.Desktop (left panel) and mobile (BurgerMenu) paths are clearly distinguished, maintaining consistency with the documentation update strategy across the PR.
src/docusaurus/docs/creating-and-managing-mentor-profile.mdx (2)
77-78: Navigation guidance properly distinguishes desktop vs. mobile.The left-panel approach for desktop and BurgerMenu icon usage for mobile follows the updated navigation pattern consistently. The embedded image reference
<img src={BurgerMenu}/>is correct.
112-114: View roles section navigation is consistent.The desktop left-panel and mobile BurgerMenu guidance is properly formatted and aligns with the updated navigation pattern throughout the file.
src/docusaurus/docs/dashboard-for-mentees.mdx (1)
17-24: Mobile navigation pattern inconsistent with other updated docs.The mentee dashboard uses a bottom-tab pattern ("click the Dashboard tab located at the bottom of the screen") for mobile, while other updated navigation guidance in this PR consistently uses the BurgerMenu icon approach. Verify whether this is intentional or should be aligned with the broader mobile navigation pattern using BurgerMenu.
src/docusaurus/docs/changepassword.mdx (1)
21-22: Navigation guidance properly updated and consistent.The desktop left-panel and mobile BurgerMenu pattern matches the established navigation approach across updated files. Formatting is correct.
src/docusaurus/docs/mentee-request.mdx (1)
1-46: New documentation page properly integrated with updated navigation patterns.The mentee-request page introduces the left-panel desktop and BurgerMenu mobile navigation consistently. Content is well-structured with appropriate use of images and admonitions. No issues identified.
src/docusaurus/docs/signing-up-as-a-mentor.mdx (1)
19-21: Logging out navigation properly updated per PR objectives.The Logout guidance has been correctly updated from Application menu to left-panel (desktop) and BurgerMenu (mobile), directly addressing the PR objective to shift from application menu to left-panel navigation.
src/docusaurus/docs/managementorrequests.mdx (2)
13-15: Navigation updated consistently with left-panel and BurgerMenu patterns.The Workspace access guidance properly distinguishes desktop left-panel from mobile BurgerMenu icon approach.
21-31: Accept/reject workflow clearly documented.The step-by-step instructions for accepting and rejecting requests are explicit and well-structured. The confirmation dialog flow is properly explained.
src/docusaurus/docs/mentor-directory.mdx (1)
17-31: Mobile navigation pattern differs from other updated docs.Like dashboard-for-mentees, this file uses a bottom-tab pattern for mobile ("click the Mentors tab located at the bottom of the screen") rather than the BurgerMenu icon approach used in creating-and-managing-mentor-profile, changepassword, and other updated files. Verify if this is intentional or should be harmonized with the broader mobile navigation updates in this PR.
| * On <b>desktop</b>: Select <b>Logout</b> from the left panel. | ||
|
|
||
| * Go to the <b>Application</b> menu <img src={BurgerMenu}/> and select <b>Logout</b>. | ||
| * On <b>mobile</b>: Tap the <img src={BurgerMenu}/> icon and select <b>Logout</b>. |
There was a problem hiding this comment.
Add alt text to the image for accessibility.
The image element on line 36 is missing alt text, which is required for accessibility compliance (WCAG). Add a descriptive alt attribute.
-* On <b>mobile</b>: Tap the <img src={BurgerMenu}/> icon and select <b>Logout</b>.
+* On <b>mobile</b>: Tap the <img src={BurgerMenu} alt="Burger menu icon"/> icon and select <b>Logout</b>.📝 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.
| * On <b>desktop</b>: Select <b>Logout</b> from the left panel. | |
| * Go to the <b>Application</b> menu <img src={BurgerMenu}/> and select <b>Logout</b>. | |
| * On <b>mobile</b>: Tap the <img src={BurgerMenu}/> icon and select <b>Logout</b>. | |
| * On <b>desktop</b>: Select <b>Logout</b> from the left panel. | |
| * On <b>mobile</b>: Tap the <img src={BurgerMenu} alt="Burger menu icon"/> icon and select <b>Logout</b>. |
🤖 Prompt for AI Agents
In src/docusaurus/docs/aboutorganizationadministrator.mdx around lines 34 to 36,
the <img> tag rendering the burger menu icon is missing an alt attribute; add a
descriptive alt prop (e.g., alt="burger menu icon" or alt="menu") to the image
JSX so it meets accessibility/WCAG requirements and conveys the icon purpose to
screen readers.
| * Find a specific mentor or mentee using the search connections. | ||
|
|
||
|
|
||
|  |
There was a problem hiding this comment.
Add descriptive alt text to all images for accessibility.
All three images are missing alt text, which is critical for screen readers and accessibility compliance. Each image should have a concise, descriptive alt attribute that explains what the image shows.
-
+-
+-
+Also applies to: 59-59, 75-75
🤖 Prompt for AI Agents
In src/docusaurus/docs/mentorsconnections.mdx at lines 18, 59, and 75, the three
image tags are missing alt text which breaks accessibility; update each image
markdown to include a concise, descriptive alt string (e.g., "Mentor matching
dashboard screenshot", "Mentor and mentee profile cards", "Mentor event calendar
view") that accurately describes the image content so screen readers can convey
the information.
|
|
||
| 2. Enter a title for the session. | ||
|
|
||
| 3. Set the the start date and the end date using the calendar icon. |
There was a problem hiding this comment.
Fix duplicate word "the".
Line 48 contains a typo: "Set the the start date" should be "Set the start date".
-3. Set the the start date and the end date using the calendar icon.
+3. Set the start date and the end date using the calendar icon.📝 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.
| 3. Set the the start date and the end date using the calendar icon. | |
| 3. Set the start date and the end date using the calendar icon. |
🤖 Prompt for AI Agents
In src/docusaurus/docs/mentorsconnections.mdx around line 48, there is a
duplicated word "the" in the sentence "Set the the start date and the end date
using the calendar icon."; remove the extra "the" so the sentence reads "Set the
start date and the end date using the calendar icon." to correct the typo.
Added step for clearing the filter in the mentee and mentor connections.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (5)
src/docusaurus/docs/mentorsconnections.mdx (2)
18-18: Add descriptive alt text to all images for accessibility (unresolved from prior review).All three images are missing alt text, which is a critical accessibility compliance issue. Each image must have a concise, descriptive alt attribute for screen readers. This was flagged in the prior review and remains unaddressed.
Apply these diffs:
- +- +- +Also applies to: 59-59, 75-75
48-48: Fix duplicate word "the" (unresolved from prior review).Line 48 contains a typo with a duplicated word: "Set the the start date" should be "Set the start date". This was previously flagged and remains unaddressed.
-3. Set the the start date and the end date using the calendar icon. +3. Set the start date and the end date using the calendar icon.src/docusaurus/docs/mentor-directory.mdx (3)
147-158: Remove invalid<p>wrapper around the list — unresolved from previous review.The
<ul>element wrapped inside a<p>produces invalid markup and renders unpredictably. The surrounding<p>tags must be removed.Apply this diff:
<Admonition type="info"> - <p> <ul> <li>You can send only one message till your message request is accepted.</li> <li>The text message can contain letters, numbers, and special characters.</li> <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, the mentee can send a new message request.</li> </ul> - </p> </Admonition>
170-170: Fix grammar: "request for a session" → "request a session" — unresolved from previous review.Change the phrasing to align with the button label and standard English usage.
Apply this diff:
-The mentee can request for a session using the **Request session** option. +The mentee can request a session using the **Request session** option.
84-84: Add missing article for consistency.Line 12 correctly reads "Send a chat request or a session request to a mentor," but Line 84 omits the second article: "Send a chat request or session request to a mentor." Align the phrasing for consistency.
Apply this diff:
-* Send a chat request or session request to a mentor. +* Send a chat request or a session request to a mentor.
🧹 Nitpick comments (1)
src/docusaurus/docs/mentorsconnections.mdx (1)
61-61: Use more specific language instead of "To do this" for clarity.The phrase "To do this, type..." is somewhat indirect. Consider rephrasing to be more explicit and direct, such as "To search, type three or more letters..." This improves documentation clarity and flow.
-You can search either by **Mentor name** or **Area of Expertise**. To do this, type three or more letters of the mentor's name or area of expertise in the search box +You can search either by **Mentor name** or **Area of Expertise**. To search, type three or more letters of the mentor's name or area of expertise in the search box
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (6)
src/docusaurus/docs/menteesconnections.mdx(1 hunks)src/docusaurus/docs/mentor-directory.mdx(3 hunks)src/docusaurus/docs/mentor-request.mdx(1 hunks)src/docusaurus/docs/mentorsconnections.mdx(1 hunks)src/docusaurus/userservices/intro.mdx(1 hunks)src/docusaurus/userservices/key-capabilities.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/docusaurus/docs/mentor-request.mdx
🚧 Files skipped from review as they are similar to previous changes (3)
- src/docusaurus/docs/menteesconnections.mdx
- src/docusaurus/userservices/intro.mdx
- src/docusaurus/userservices/key-capabilities.mdx
🧰 Additional context used
🪛 LanguageTool
src/docusaurus/docs/mentor-directory.mdx
[style] ~10-~10: Consider a more expressive alternative.
Context: .... * View all the mentors' profiles. To do this, click anywhere on the mentor's ca...
(DO_ACHIEVE)
src/docusaurus/docs/mentorsconnections.mdx
[style] ~61-~61: Consider a more expressive alternative.
Context: ...tor name** or Area of Expertise. To do this, type three or more letters of the...
(DO_ACHIEVE)
🔇 Additional comments (1)
src/docusaurus/docs/mentorsconnections.mdx (1)
1-92: Overall structure and content quality look solid.The documentation is well-organized with clear step-by-step instructions, appropriate use of Admonitions for callouts, and good hierarchy. Once the accessibility issues (alt text on images) and the typo on line 48 are resolved, this will be ready.
updated file extn for mentordirectory-icon to PNG
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (2)
src/docusaurus/docs/mentor-directory.mdx (2)
147-158: Remove invalid<p>wrapper around the list (previously flagged, still unaddressed).Wrapping
<ul>inside<p>produces invalid HTML markup and will render unpredictably. This issue was flagged in a prior review but remains unaddressed.Apply this diff to fix the markup:
<Admonition type="info"> - <p> <ul> <li>You can send only one message till your message request is accepted.</li> <li>The text message can contain letters, numbers, and special characters.</li> <li>The first message you send is limited to 160 characters. Subsequent messages can have a maximum of 255 characters.</li> <li>You will be able to send a message to the mentor again only when the mentor has either accepted the request or rejected it. If the message gets rejected, the mentee can send a new message request.</li> </ul> - </p> </Admonition>
170-170: Fix "request for a session" → "request a session."Line 170 still contains the awkward phrasing "request for a session" flagged in a prior review. Change it to "request a session" for more natural grammar.
Apply this diff:
-The mentee can request for a session using the **Request session** option. +The mentee can request a session using the **Request session** option.
🧹 Nitpick comments (3)
src/docusaurus/userservices/intro.mdx (3)
3-5: Break up the overview sentence for better readability.The overview combines multiple concepts in a single dense sentence, making it harder to parse. Consider restructuring into 2-3 shorter sentences:
-Using the user services building block, organizations and individuals can effectively streamline the -user management and organization management capabilities. This includes user registration, the login process, multi-tenancy, role-based access, -profile management, permissions, and secure access to the applications. +Using the user services building block, organizations and individuals can effectively streamline user management and organization management. Key capabilities include user registration, login processes, multi-tenancy support, and role-based access control. The system also manages profile information, permissions, and ensures secure application access.
12-13: Break up the long multi-tenant explanation into multiple sentences.The architecture explanation combines too many concepts in a single run-on sentence (~90 words). Separate into logical chunks for clarity:
-This model uses a single shared database instance for all tenants. Data is segregated at the application or database layer using tenant IDs. Backend DB is same across all tenants. Within a tenant, the organization structure exists. For example, each tenant can have a number of organizations like Org1, Org2, Org3, and so on under it. The tenants will have their own data and configurations within the system. +This architecture uses a single shared database instance for all tenants, with data segregated at the application or database layer using tenant IDs. Within each tenant, an organization structure allows multiple organizations (e.g., Org1, Org2, Org3) to coexist. Each tenant maintains isolated data and configurations within the shared system.
1-13: Clarify the scope and connection to mentor workflows.The introduction focuses on generic User Services and multi-tenant architecture, but the PR objective emphasizes updates to "signing up as a mentor" documentation. Consider adding:
- A brief mention of how mentor workflows fit into the User Services building block
- A link or reference to mentor-specific setup/signup documentation
- Context about the left-panel navigation mentioned in the PR objective
This would better establish the connection between User Services foundation and mentor-specific flows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
src/docusaurus/docs/mentor-directory.mdx(3 hunks)src/docusaurus/userservices/intro.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/docusaurus/docs/mentor-directory.mdx
[style] ~10-~10: Consider a more expressive alternative.
Context: .... * View all the mentors' profiles. To do this, click anywhere on the mentor's ca...
(DO_ACHIEVE)
🔇 Additional comments (1)
src/docusaurus/docs/mentor-directory.mdx (1)
6-6: Approve grammar and clarity improvements in intro.The opening section now reads correctly with proper possessive forms ("mentors' profiles") and articles ("a chat request"). The updated navigation reference to the "left panel" (line 17) also aligns well with the PR objective to replace application menu references.
Also applies to: 10-10, 12-12
Updated docusaurus file for adding the versiondropdown for Mentor
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
src/docusaurus/docusaurus.config.js (2)
199-207: Newuserservicesdocs plugin is correctly wired; check naming vs existinguserservicepluginThe new plugin entry for
userservices(id/path/routeBasePath + sidebar) looks valid and consistent with the other docs plugins.Given there is already a
userserviceplugin (singular), please confirm:
- That
userservicesis intentionally a distinct surface (e.g., user‑facing docs vs backend service docs), and- That sidebar + docs structure under
userservices/(especiallyintro) are present and build without broken routes.If you expect future contributors to be confused, consider a slightly more distinctive id (e.g.,
user-app-docs) while keeping the same routeBasePath.
308-317: Top‑level “User Services” link is wired correctly; consider UX naming alignmentThe navbar item correctly targets the
userservicesplugin (docId: 'intro', docsPluginId: 'userservices'), so routing should resolve to/userservices/intro(assuming that doc exists).Given the nearby “Supporting Services → User Service” entry that uses the
userserviceplugin, you might want to:
- Confirm both entries point to distinct concepts (e.g., app vs microservice), and
- Optionally tweak one of the labels/descriptions for clearer differentiation for end users.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/docusaurus/docusaurus.config.js(4 hunks)
🔇 Additional comments (3)
src/docusaurus/docusaurus.config.js (3)
35-62: Mentor docs versioning config looks structurally correct; please validate versioned content existsThe
docsversioning block (current + 3.1/3.0/2.6/2.5) is well‑formed and consistent, and the labels align with the Mentor naming.Please just double‑check that:
- Versioned content for
3.1and3.0actually exists at the expected paths, and- The updated labels for
2.6and2.5match how these versions are referenced elsewhere in the docs/UX.
233-240: Docs version dropdown is correctly targeted at the Mentor docs; verify runtime behaviourUsing
type: 'docsVersionDropdown'withoutdocsPluginIdwill bind the dropdown to the default Mentor docs plugin configured in theclassicpreset, which matches the versioning block you defined.Please verify in a local build that:
- The dropdown shows “Mentor 3.2” and the other labeled versions as expected.
- Switching versions correctly routes within the
/mentordocs and doesn’t interfere with the other docs plugins.
321-327: Whitespace‑only changes around the Help navbar itemThis hunk only adjusts whitespace and does not affect behaviour; no further action needed.
Updated the images for login and register docs
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
src/docusaurus/sidebarsUserservices.js (1)
15-181: Consider standardizing the formatting for consistency.The sidebar configuration is functionally correct, but has inconsistent spacing and indentation throughout (e.g., extra blank lines at lines 40, 46, 78, 92-94, 113, 148, 179). Standardizing the formatting would improve readability and maintainability.
💡 Example of consistent formatting
For consistency, consider formatting all category blocks similarly:
] - }, - - - + }, { type: 'category',src/docusaurus/userservices/login.mdx (1)
7-7: Consider using "username" (one word) for consistency.Modern documentation typically uses "username" as a single word rather than "user name". This aligns with common UI/UX terminology conventions.
🔎 Suggested change
-1. Enter your e-mail or mobile number or user name. +1. Enter your email or mobile number or username.Note: Also consider "email" (one word) for consistency.
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
src/docusaurus/userservices/media/forgotpassword.pngis excluded by!**/*.pngsrc/docusaurus/userservices/media/login-register.pngis excluded by!**/*.pngsrc/docusaurus/userservices/media/login.pngis excluded by!**/*.pngsrc/docusaurus/userservices/media/registerform.pngis excluded by!**/*.png
📒 Files selected for processing (4)
src/docusaurus/sidebarsUserservices.js(1 hunks)src/docusaurus/userservices/forgotpwd.mdx(1 hunks)src/docusaurus/userservices/login.mdx(1 hunks)src/docusaurus/userservices/register.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- src/docusaurus/userservices/forgotpwd.mdx
🚧 Files skipped from review as they are similar to previous changes (1)
- src/docusaurus/userservices/register.mdx
🧰 Additional context used
🧬 Code graph analysis (1)
src/docusaurus/sidebarsUserservices.js (1)
src/docusaurus/sidebars.js (1)
sidebars(15-419)
🪛 LanguageTool
src/docusaurus/userservices/login.mdx
[style] ~7-~7: It’s more common nowadays to write this noun as one word.
Context: .... Enter your e-mail or mobile number or user name. 2. Enter your password. 
🔇 Additional comments (2)
src/docusaurus/sidebarsUserservices.js (1)
1-14: LGTM!The file header and TypeScript setup follow standard Docusaurus conventions correctly.
src/docusaurus/userservices/login.mdx (1)
1-6: LGTM!The header and introduction are clear and concise.
|
|
||
| 2. Enter your password. | ||
|
|
||
|  |
There was a problem hiding this comment.
Add alt text for accessibility.
The image is missing alt text, which is important for screen readers and accessibility compliance. Consider adding descriptive alt text that explains what the image shows.
🔎 Suggested fix
- 
+ 📝 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.
|  | |
|  |
🤖 Prompt for AI Agents
In src/docusaurus/userservices/login.mdx around line 11, the image tag uses
 with no alt text; update the MDX image to include
descriptive alt text (e.g., ) so screen readers receive meaningful context, ensuring
the alt string concisely describes the image content.
Updated sidebarsUserservices
1 participant
Updated signing up as a mentor file, changed to left panel instead of application menu
Summary by CodeRabbit