Conversation
WalkthroughReplaces the instructor "Bookstore Pay" docs with a structured "Bookstore Pay (Access Codes)" workflow (ISBN mappings, ordering, bookstore management, invoice guidance) and updates the student payment docs to show a payment dialog, new navigation fallback, and a revised Redeem Code flow. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Bookstore
participant Accounts as Codio Accounts
participant System as Codio System (codes & invoices)
Note over Bookstore,System: Bookstore Pay (Access Codes) ordering flow
Bookstore->>Accounts: Email order (subscription types, quantities)
Accounts->>System: Request generation of codes & invoice
System-->>Accounts: Return printable letter, CSV of access codes, invoice
Accounts-->>Bookstore: Send artifacts to bookstore
Note over Bookstore: Unsold access codes remain active (no refunds)
sequenceDiagram
autonumber
actor Student
participant UI as Codio UI
participant Billing as Billing Service
Note over Student,UI: Student payment / redeem flow
UI-->>Student: Show payment dialog (when applicable)
Student->>UI: If dialog missing → Username > Preferences > Billing
Student->>UI: Open Plan dialog → Select Redeem Code
UI->>Billing: Submit access code for redemption
Billing-->>UI: Confirm activation
UI-->>Student: Access enabled
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Suggestions: verify the ISBN → subscription mapping table for completeness and consistent formatting; clarify institution-specific setup steps (who configures course-to-subscription mappings) and explicitly state whether access codes can be reissued or transferred to avoid ambiguity. Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
student-source/students/accessing-codio/paying.rst (1)
45-46: Align terminology in Step 3Please update “click your User name > Preferences > Billing” to use the same “username” phrasing that appears elsewhere in the page. The current mix of “User name” and “username” is jarring and may cause readers to pause.
source/instructors/admin/orgbilling.rst (2)
71-72: Polish the note sentenceConsider rephrasing to “Note that the setup is institution-specific.” The added “that” and the hyphenated compound adjective tighten the wording and keep the tone consistent with surrounding guidance.
103-106: Tidy bullet spacingLine 105 contains a double space in “should manage.” Please collapse it to a single space to avoid visual hiccups in the rendered list.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
source/instructors/admin/orgbilling.rst(1 hunks)student-source/students/accessing-codio/paying.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:
student-source/students/accessing-codio/paying.rstsource/instructors/admin/orgbilling.rst
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
student-source/students/accessing-codio/paying.rst (1)
45-46: Clarify the navigation wording for readability.The sentence “click your Username > Preferences > Billing” is a bit awkward. Please rephrase to explicitly tell students to open their username menu, choose Preferences, and then Billing—for example, “click your username in the top-right corner, choose Preferences, then open Billing.” That keeps the navigation steps easy to follow.
source/instructors/admin/orgbilling.rst (1)
92-99: Tighten the ordering instructions for smoother reading.The phrase “places an email order with this information to accounts@codio.com” is clumsy. Consider wording it as “sends an email with this information to accounts@codio.com” (and mention attaching the purchase order if needed). It reads more naturally while keeping the process clear.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
source/instructors/admin/orgbilling.rst(1 hunks)student-source/students/accessing-codio/paying.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/admin/orgbilling.rststudent-source/students/accessing-codio/paying.rst
There was a problem hiding this comment.
Actionable comments posted: 3
🧹 Nitpick comments (4)
source/instructors/getstarted/support/changelog.rst (1)
16-19: Capitalize “Guides” and consider a cross-refSuggest “New Guides button for uploading files.” If there’s a relevant doc section, link it with :ref: for consistency.
source/instructors/admin/orgbilling.rst (3)
67-82: Use proper subsection headings instead of boldFor consistency with the rest of the page, promote these bolded lines to rst subsections.
Example:
-**1. Determining License Requirements** +Determining License Requirements +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^Repeat similarly for “Ordering Process” and “Bookstore Management Guidelines.”
89-91: Capitalize PDFMinor style tweak for consistency.
-- A printable pdf letter to give to each student purchasing a code, providing instructions for code use. +- A printable PDF letter to give to each student purchasing a code, providing instructions for code use.
93-99: Hyphenate and clarify policy bulletsTighten wording and hyphenation.
-- Access codes never expire and are not course specific, allowing them to be sold in future semesters. +- Access codes never expire and are not course-specific, allowing them to be sold in future semesters. -- Bookstores should manage the codes like physical stock and can place additional code orders at any time. +- Bookstores should manage access codes like physical stock and can place additional code orders at any time. -- Codes are non-refundable. +- Access codes are non-refundable.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
source/img/manage_organization/orgbilltab.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (2)
source/instructors/admin/orgbilling.rst(2 hunks)source/instructors/getstarted/support/changelog.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/getstarted/support/changelog.rstsource/instructors/admin/orgbilling.rst
🔇 Additional comments (1)
source/instructors/admin/orgbilling.rst (1)
72-81: Confirm ISBN mappingsPlease verify these ISBNs with Product/Finance and add a brief note if they ever change or are region-specific.
| 1. Enter the **Number of students** and **Student start date**. | ||
|
|
||
| 2. Enter the student start date. | ||
| 2. Enter **Promotion Code** (if any). Codes are not case sensitive, valid for new users only, and not for student pay plans. Invalid or expired codes will display a message. | ||
|
|
||
| 3. If you have a promotion code, enter it in the appropriate field. Validation is case insensitive. | ||
| 4. Enter **Purchase Order** Number (if applicable) and **Billing Email**. | ||
|
|
||
| - If the promotion code is invalid, the message | ||
| ``Invalid promotion code`` will be shown | ||
| - If the promotion code has expired, the message | ||
| ``This promotion code has expired`` will be shown | ||
| - Promotion codes are only available for new users and not available for student pay plans. | ||
| 5. **Select a Plan** (semester or annual). | ||
|
|
||
| 4. Enter a billing email address. | ||
|
|
||
| 5. The plans available will be shown (semester or annual), select the plan you require and if you require the invoice to be sent to someone else, you can change the recipient. | ||
|
|
||
| 6. When you are ready, click the 'Generate Invoice' button or 'Generate Quote' button as per your requirement, and the invoice or quote will be generated and sent to the email address. | ||
| 6. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided. |
There was a problem hiding this comment.
Fix step numbering and tighten phrasing
List skips “3.” and mixes numbering. Use auto-numbering and minor grammar fixes.
Apply:
-1. Enter the **Number of students** and **Student start date**.
-
-2. Enter **Promotion Code** (if any). Codes are not case sensitive, valid for new users only, and not for student pay plans. Invalid or expired codes will display a message.
-
-4. Enter **Purchase Order** Number (if applicable) and **Billing Email**.
-
-5. **Select a Plan** (semester or annual).
-
-6. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided.
+1. Enter the **Number of students** and **Student start date**.
+1. Enter **Promotion Code** (if any). Codes are not case-sensitive, valid for new users only, and not valid for Student Pay plans. Invalid or expired codes will display a message.
+1. Enter **Purchase Order Number** (if applicable) and **Billing Email**.
+1. **Select a plan** (semester or annual).
+1. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided.📝 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. Enter the **Number of students** and **Student start date**. | |
| 2. Enter the student start date. | |
| 2. Enter **Promotion Code** (if any). Codes are not case sensitive, valid for new users only, and not for student pay plans. Invalid or expired codes will display a message. | |
| 3. If you have a promotion code, enter it in the appropriate field. Validation is case insensitive. | |
| 4. Enter **Purchase Order** Number (if applicable) and **Billing Email**. | |
| - If the promotion code is invalid, the message | |
| ``Invalid promotion code`` will be shown | |
| - If the promotion code has expired, the message | |
| ``This promotion code has expired`` will be shown | |
| - Promotion codes are only available for new users and not available for student pay plans. | |
| 5. **Select a Plan** (semester or annual). | |
| 4. Enter a billing email address. | |
| 5. The plans available will be shown (semester or annual), select the plan you require and if you require the invoice to be sent to someone else, you can change the recipient. | |
| 6. When you are ready, click the 'Generate Invoice' button or 'Generate Quote' button as per your requirement, and the invoice or quote will be generated and sent to the email address. | |
| 6. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided. | |
| 1. Enter the **Number of students** and **Student start date**. | |
| 1. Enter **Promotion Code** (if any). Codes are not case-sensitive, valid for new users only, and not valid for Student Pay plans. Invalid or expired codes will display a message. | |
| 1. Enter **Purchase Order Number** (if applicable) and **Billing Email**. | |
| 1. **Select a plan** (semester or annual). | |
| 1. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided. |
🤖 Prompt for AI Agents
In source/instructors/admin/orgbilling.rst around lines 31 to 39, the ordered
list skips number 3 and has inconsistent numbering and wording; replace the
hard-coded numbers with reStructuredText auto-numbering (use "1." for each item)
so the renderer generates correct sequential numbers, and revise phrasing for
clarity—e.g., "Enter the number of students and the student start date.", "Enter
a promotion code (if any). Codes are not case-sensitive, apply to new users
only, and are not valid for student pay plans; invalid or expired codes will
display a message.", "Enter a purchase order number (if applicable) and a
billing email.", "Select a plan (semester or annual).", "Click Generate Invoice
or Generate Quote; the document will be sent to the provided email." Ensure
punctuation and capitalization are consistent.
| @@ -64,19 +56,47 @@ The option to switch to a **Student Pay plan** where students are prompted to en | |||
|
|
|||
| 4. To support students in this process, provide them with `this documentation link <https://docs.codio.com/students/accessing-codio/paying.html#pay-for-codio-subscription>`__ with specific emphasis to `this section <https://docs.codio.com/students/accessing-codio/paying.html#problems-setting-up-a-new-subscription-plan>`__ in the event they have problems especially if this may be first time they are trying to purchase online and the transaction may be refused by their bank due to the ever increasing fraud prevention measures card issuers are implementing or guide them to contact help@codio.com. | |||
There was a problem hiding this comment.
🧩 Analysis chain
Verify student-doc anchors
Ensure these anchors still exist after the student-docs update; broken links hurt support flows.
🏁 Script executed:
#!/bin/bash
# Check that referenced fragments exist in any paying.rst
fd -a paying.rst | while read -r f; do
echo "File: $f"
rg -n -C1 'pay-for-codio-subscription|problems-setting-up-a-new-subscription-plan' "$f" || true
doneLength of output: 75
🏁 Script executed:
#!/bin/bash
f=$(fd -a paying.rst)
echo "subscription occurrences:"
rg -n 'subscription' "$f" || echo "none"
echo ""
echo "problems occurrences:"
rg -n 'problems' "$f" || echo "none"Length of output: 150
Fix broken anchor links in orgbilling.rst
The fragments #pay-for-codio-subscription and #problems-setting-up-a-new-subscription-plan don’t exist in students/accessing-codio/paying.rst; update those links to match the current section anchors.
🤖 Prompt for AI Agents
In source/instructors/admin/orgbilling.rst around line 57, the two fragment
anchors in the external links (#pay-for-codio-subscription and
#problems-setting-up-a-new-subscription-plan) are invalid for
students/accessing-codio/paying.rst; open students/accessing-codio/paying.rst,
find the exact section headings or generated anchor IDs for the “pay for Codio
subscription” and “problems setting up a new subscription plan” sections, then
replace the broken fragment anchors with the correct anchors (or convert the
links to Sphinx cross-reference roles like :ref:`<label>` pointing to the proper
section label) so the links resolve to the existing sections. Ensure both
updated links exactly match the target anchors/labels and keep the fallback
contact help@codio.com text unchanged.
| Bookstore Pay (Access Codes) | ||
| ---------------------------- | ||
| Codio offers the option to provide licenses through your institution's campus bookstore. This enables students, especially those using financial aid, to purchase an access code directly from the bookstore. The access code serves as the Codio license. When students first access their Codio account, they simply enter the access code to activate their license. | ||
|
|
||
| Only one access code is required per student even if the student is enrolled in multiple courses. Instructors provide students with information on how to use the code, and additional guidance is available on each student's page. Note that the setup is institution-specific. | ||
|
|
||
| Any unsold access codes will remain active and can be used in subsequent semesters. | ||
|
|
There was a problem hiding this comment.
Clarify where students find guidance
“additional guidance is available on each student's page” is vague. Specify the exact location (e.g., Billing dialog or “Redeem a code” section) and consider linking to the student “Redeem Code” doc.
🤖 Prompt for AI Agents
In source/instructors/admin/orgbilling.rst around lines 59 to 66, the phrase
“additional guidance is available on each student's page” is too vague; update
it to point to the exact UI location (e.g., the student’s Billing dialog under
the “Redeem a code” section) and add a link to the student-facing “Redeem Code”
documentation (or the appropriate internal URL/path) so instructors can
reference the exact help page; reword the sentence to: “Additional guidance
appears on the student’s Billing dialog under ‘Redeem a code’ — see the student
‘Redeem Code’ doc [link].”
2 participants
Summary by CodeRabbit