Conversation
WalkthroughUpdated wording across instructor and student docs to describe the course join token as a "multi-word token", simplify join-flow wording (hyperlink to Join Course), clarify token-based rejoin/revocation instructions (regenerate token to revoke access), and fix minor typos and phrasing for test-student and archive instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (4)
source/instructors/setupcourses/add-remove-students.rst (4)
14-14: Remove duplicated phrase in the introductory sentence.The sentence repeats “follow these steps.” Clean this up.
-To add a student to your course, follow these steps: follow these steps to add students to a course: +To add a student to your course, follow these steps:
49-49: Fix possessive form in UI reference.Grammatical correction in the Note.
- .. Note:: When logged in as a test student, you will see a bar on the top of the window letting you know you are logged in as a test student. You can switch back to your main teacher account by selecting **Switch back to teachers account**. + .. Note:: When logged in as a test student, you will see a bar at the top of the window indicating you are logged in as a test student. You can switch back to your main teacher account by selecting **Switch back to teacher's account**.
66-66: Clarify rejoin behavior; fix grammar/capitalization and add punctuation.Use “either of the options,” lowercase “regenerate,” and refer to the “previous token.”
-4. Students can rejoin the course using either the options above. If you wish to prevent this, you can **Regenerate** the student token so the previously advised code will not work +4. Students can rejoin the course using either of the options above. If you want to prevent this, **regenerate** the student token so the previous token no longer works.
86-86: Fix typo (“meno” → “menu”) and add period.-4. Teachers can unarchive students from the same **Options** meno +4. Teachers can unarchive students from the same **Options** menu.
🧹 Nitpick comments (4)
source/instructors/setupcourses/add-remove-students.rst (2)
30-30: Tighten phrasing and use rst link markup for consistency.Recommend small edits for clarity, tone, and rst style. Also avoid “our” in product docs.
- - Copy the multi-word token and send to your students. Instruct your students to go to https://codio.com/p/join-class or click the **Join Course** button on our main website. They should enter the token and register their Codio account. + - Copy the multi-word token and send it to your students. Ask them to go to `Join Course <https://codio.com/p/join-class>`_ on the Codio website, enter the token, and then sign in or create a Codio account.
34-34: Streamline Note wording and avoid filler.Tighten the sentence and keep capitalization consistent.
- .. Note:: We would recommend the Student Invite URL option as all the students need to do is enter that URL into their browser to join the correct course in your organization. + .. Note:: We recommend the Student Invite URL option because students can simply open the URL to join the correct course in your organization.student-source/accessing-codio.rst (2)
27-27: Remove extra space in rst link and consider minor wording tweak.There’s a double space before the “<”. Also, “Enter the token and click Next.” could be reordered to reflect the UI if it prompts for token first, then Next.
-- Send you a multi-word token that you can enter on the Codio website using `Join Course <https://codio.com/p/join-class>`_. Enter the token and click **Next**. +- Send you a multi-word token that you can enter on the Codio website using `Join Course <https://codio.com/p/join-class>`_. Enter the token, then click **Next**.
29-31: Improve image alt text for accessibility.“Auth token” is vague. Make the alt text describe what the image shows.
- .. image:: /img/joinclass.png - :alt: Auth token + .. image:: /img/joinclass.png + :alt: Join Course page showing token entry field
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
source/instructors/setupcourses/add-remove-students.rst(1 hunks)student-source/accessing-codio.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.
Files:
source/instructors/setupcourses/add-remove-students.rststudent-source/accessing-codio.rst
🔇 Additional comments (1)
student-source/accessing-codio.rst (1)
27-27: Terminology update looks good.Switching to “multi-word token” improves accuracy and aligns with the other page.
shajason
left a comment
shajason
left a comment
There was a problem hiding this comment.
Code rabbit found some good things1 Where it says that Regenerate should be lower cased - I think we should change the sentence because there is no longer a regenerate button. It could be something like: (you can reword!)
Students will still be able to join the course using the token or URL link if that is how they enrolled. If you wish to prevent this, you can regenerate the student token by clicking on the circular arrow icon next to the token name, and the old token will no longer work.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
source/instructors/setupcourses/add-remove-students.rst (5)
30-30: Clarify the join flow with the missing “Next” actionRecommend explicitly mentioning the “Next” UI step after entering the token to match the typical flow and reduce confusion.
Please confirm the exact button label in the current UI (“Next” vs. “Continue”). If different, adjust accordingly.
- - Copy the multi-word token and send it to your students. Ask them to go to `Join Course <https://codio.com/p/join-class>`_ on the Codio website, enter the token, and then sign in or create a Codio account. + - Copy the multi-word token and send it to your students. Ask them to go to `Join Course <https://codio.com/p/join-class>`_ on the Codio website, enter the token, click **Next**, and then sign in or create a Codio account.
34-34: Tighten phrasing and avoid repetition around “URL”Minor wording cleanup for readability. Also, confirm whether “Student Invite URL” is a formal UI term; if not, prefer sentence case (“Student invite URL”) consistently across docs.
Please verify if “Student Invite URL” matches the actual UI copy.
- .. Note:: We recommend the Student Invite URL option because students can simply open the URL to join the correct course in your organization. + .. Note:: We recommend using the Student Invite URL because students can simply open it to join the correct course in your organization.
49-49: Reduce repetition and align with UI copy for the switch-back actionEliminates repeated “logged in as a test student,” uses “banner” for clarity, and aligns the button label (please verify exact wording).
Confirm the exact button text (“Switch back to teacher account” vs. “Switch back to teacher's account”) to match the UI.
- .. Note:: When logged in as a test student, you will see a bar at the top of the window indicating you are logged in as a test student. You can switch back to your main teacher account by selecting **Switch back to teacher's account**. + .. Note:: When logged in as a test student, you will see a banner at the top of the window indicating your test-student session. To return to your teacher account, select **Switch back to teacher account**.
66-66: Fix run-on sentence and clarify token rotation effectAdds missing punctuation, removes “URL link” redundancy, and explicitly states that regenerating the token deactivates the old Join URL.
-4. Students can rejoin the course using any of the options above. Students who originally enrolled using the course token or URL link will continue to have access through those methods. To revoke access via the original token, simply regenerate it by clicking the circular arrow icon next to the token name this will deactivate the old token and create a new one. +4. Students can rejoin the course using any of the options above. Students who originally enrolled using the course token or URL will continue to have access through those methods. To revoke access via the original token, regenerate it by clicking the circular-arrow icon next to the token name. This deactivates the old token (and its Join URL) and creates a new one.
86-86: Disambiguate where to unarchiveSpecifies the location of the Options menu to avoid “same menu” ambiguity.
-4. Teachers can unarchive students from the same **Options** menu. +4. Teachers can unarchive students from the student's **Options** menu on the **Students** tab.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (2)
source/instructors/setupcourses/add-remove-students.rst(5 hunks)student-source/accessing-codio.rst(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- student-source/accessing-codio.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Clear and concise language.
- Correct grammar and spelling.
- Proper use of rst syntax (e.g., avoid broken links or invalid code blocks).
- Adherence to style guides (e.g., consistent tone, terminology).
Suggest improvements to enhance readability and accessibility.
Files:
source/instructors/setupcourses/add-remove-students.rst
🔇 Additional comments (1)
source/instructors/setupcourses/add-remove-students.rst (1)
14-14: Good improvement to lead-in sentenceClear and instructive; sets up the numbered steps well.
2 participants
Summary by CodeRabbit