Merged
Conversation
WalkthroughAdds a new instructor guide "Batch Assessment Update", inserts it into the Courses toctree, and updates the assessments page to reference bulk/batch assessment updates and link to the new guide. All changes are documentation-only. (≤50 words) Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 7
🤖 Fix all issues with AI agents
In @source/instructors/setupcourses/batch-assessment-update.rst:
- Line 29: Replace the conversational sentence "Here is a reference guide on how
to update your template file:" with a concise, direct section header such as
"Updating the template file" or "Template file update guide"; edit the line that
currently contains that full phrase to a short header string (e.g., "Updating
the template file") and ensure it uses the same heading markup style as
surrounding headers.
- Around line 55-57: Update the row heading string "Defined Number of Attempts"
to "Number of Attempts" in the batch assessment update table so it matches the
naming pattern used by the other rows; locate the occurrence of "Defined Number
of Attempts" in the source/instructors/setupcourses/batch-assessment-update.rst
content and replace it with "Number of Attempts".
- Around line 80-82: Update the image alt text to match the Excel file format:
locate the image directive ".. image::
/img/guides/select-excel-batch-update.png" and replace the :alt: value "Select
csv Batch Update" with something accurate like "Select Excel Batch Update" (or
"Select .xlsx Batch Update") so the alt text matches the document's Excel focus.
- Around line 21-26: The heading "Things you should know about the template:" is
informal; update it to a more professional, consistent documentation style such
as "Important notes about the template:", "Template usage guidelines:", or
"Before editing the template:" by replacing the existing heading text in the RST
file (the line containing that phrase) with one of these alternatives and ensure
the surrounding bullet list remains unchanged.
- Around line 61-63: Clarify the "Value (for ATTEMPTS/SCORE)" row by replacing
the ambiguous range text with an explicit rule: state that when "Show Rationale
to Student" is set to ATTEMPTS the value must be an integer 1–99, when set to
SCORE the value must be a percentage 0–100, and leave the field blank when "Show
Rationale to Student" is disabled or set to any other option; update the row
labeled "Value (for ATTEMPTS/SCORE)" accordingly so readers can immediately map
the setting to the correct numeric range.
- Around line 11-13: Remove the double space before "template" and rewrite the
two sentences to be more concise and direct: mention that users should download
the Excel (.xlsx) template from "Download Assessment Template" in the Assessment
Settings → Bulk Settings, then update the fields in that file as needed to
perform bulk updates for points, partial points, use of maximum score, show
expected answer, number of attempts, and showing rationale to students; replace
"as per your requirements" with "as needed" and ensure single spacing
throughout.
- Around line 66-68: The transition sentence "Once you have updated/modified
your Excel (.xlsx) template file now you are ready to bulk update the assessment
settings." is a run-on and should be rewritten for clarity; replace it with a
single corrected sentence such as "Once you have updated your Excel (.xlsx)
template, you are ready to bulk update the assessment settings." to remove
redundancy and fix punctuation (reference the sentence starting with "Once you
have updated/modified your Excel (.xlsx) template...").
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
source/img/guides/assessment-screenshot-XLSX-bulk-template.pngis excluded by!**/*.png,!**/*.pngsource/img/guides/select-excel-batch-update.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (3)
source/instructors/authoring/assessments/assessments.rstsource/instructors/setupcourses/batch-assessment-update.rstsource/instructors/setupcourses/courses.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use
list-table.- 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.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/setupcourses/courses.rstsource/instructors/authoring/assessments/assessments.rstsource/instructors/setupcourses/batch-assessment-update.rst
🧠 Learnings (1)
📚 Learning: 2025-12-11T12:13:36.657Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:84-104
Timestamp: 2025-12-11T12:13:36.657Z
Learning: Documented template usage: In Codio coachBot API, use the template syntax {% prompt 'PROMPT_ID' %} within custom extensions to reference organization-level prompts. This pattern should be described in all relevant reStructuredText docs (all .rst files) where prompts are referenced. The template resolves server-side to fetch the prompt text matching PROMPT_ID from the organization's stored prompts; explain this behavior and ensure examples show PROMPT_ID usage for clarity.
Applied to files:
source/instructors/setupcourses/courses.rstsource/instructors/authoring/assessments/assessments.rstsource/instructors/setupcourses/batch-assessment-update.rst
🔇 Additional comments (2)
source/instructors/setupcourses/courses.rst (1)
48-48: LGTM!The toctree entry is properly formatted and consistently placed with the other course setup topics.
source/instructors/authoring/assessments/assessments.rst (1)
14-15: LGTM!The addition clearly introduces the bulk assessment update capability and properly references the new documentation page.
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)
source/instructors/setupcourses/courses.rst (1)
23-23: Remove trailing whitespace for consistent formatting.Lines 23 and 42 contain trailing spaces after the toctree entry names. While this doesn't affect functionality, removing trailing whitespace maintains consistent formatting throughout the file.
Also applies to: 42-42
🤖 Fix all issues with AI agents
In `@source/instructors/setupcourses/courses.rst`:
- Line 48: Move the "batch-assessment-update" toc entry out of the coach/LLM
section and place it adjacent to the other batch operations such as
"batch-groups-upload" and "batch-student-tagging" (lines near the existing batch
entries) or next to "bulk-assignment-update" so it groups logically with related
bulk/batch features; also review the naming convention between "batch-" and
"bulk-" and, if there is no semantic difference, rename
"batch-assessment-update" to match the prevailing prefix (or rename the other
entries to match) and update any cross-references or links that point to
"batch-assessment-update" accordingly.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/courses.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use
list-table.- 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.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/setupcourses/courses.rst
🧠 Learnings (1)
📚 Learning: 2025-12-11T12:13:36.657Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:84-104
Timestamp: 2025-12-11T12:13:36.657Z
Learning: Documented template usage: In Codio coachBot API, use the template syntax {% prompt 'PROMPT_ID' %} within custom extensions to reference organization-level prompts. This pattern should be described in all relevant reStructuredText docs (all .rst files) where prompts are referenced. The template resolves server-side to fetch the prompt text matching PROMPT_ID from the organization's stored prompts; explain this behavior and ensure examples show PROMPT_ID usage for clarity.
Applied to files:
source/instructors/setupcourses/courses.rst
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Fix all issues with AI agents
In `@source/instructors/setupcourses/batch-assessment-update.rst`:
- Line 29: Remove the trailing space after the colon in the heading "**Template
field reference:** " by editing that heading to "**Template field reference:**"
so it matches the rest of the document's punctuation and spacing.
- Around line 22-24: Three list lines ("Edit only the white cells with dropdowns
or number inputs.", "Leave any cell set to No Change to keep the current
published setting.", "Gray cells labeled Not Supported or Restricted cannot be
edited for the selected assessment type.") contain trailing tab characters;
remove the trailing whitespace/tabs at the ends of these lines so they end
cleanly with the sentence and no extra characters, ensuring consistent
formatting in batch-assessment-update.rst.
- Line 84: Update the confirmation button text in the sentence "A popup window
will appear asking you to confirm, click **yes**." by capitalizing the button
label to "Yes" so it reads "click **Yes**." Replace the lowercase "yes" with
"Yes" in the content of batch-assessment-update.rst to maintain UI text
consistency.
♻️ Duplicate comments (1)
source/instructors/setupcourses/batch-assessment-update.rst (1)
82-82: Capitalize "Excel" in alt text.The alt text uses lowercase "excel" which is inconsistent with the capitalization used throughout the document. "Excel" should be capitalized as it's a product name.
✏️ Suggested fix
- :alt: Select excel Batch Update + :alt: Select Excel Batch Update
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/batch-assessment-update.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use
list-table.- 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.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/setupcourses/batch-assessment-update.rst
🧠 Learnings (1)
📚 Learning: 2025-12-11T12:13:36.657Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:84-104
Timestamp: 2025-12-11T12:13:36.657Z
Learning: Documented template usage: In Codio coachBot API, use the template syntax {% prompt 'PROMPT_ID' %} within custom extensions to reference organization-level prompts. This pattern should be described in all relevant reStructuredText docs (all .rst files) where prompts are referenced. The template resolves server-side to fetch the prompt text matching PROMPT_ID from the organization's stored prompts; explain this behavior and ensure examples show PROMPT_ID usage for clarity.
Applied to files:
source/instructors/setupcourses/batch-assessment-update.rst
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Fix all issues with AI agents
In `@source/instructors/getstarted/support/changelog.rst`:
- Line 18: The changelog line redundantly repeats "feature"; update the entry
that currently reads "Added :ref:`Batch Assessment Update
<batch-assessment-update>` feature to update..." so it omits the extra word and
reads e.g. "Added :ref:`Batch Assessment Update <batch-assessment-update>` to
update assessment settings in bulk using a .xlsx file." Locate the string in
changelog.rst (the line containing the reference :ref:`Batch Assessment Update
<batch-assessment-update>`) and remove the word "feature" after the reference,
keeping the rest of the description unchanged.
♻️ Duplicate comments (7)
source/instructors/setupcourses/batch-assessment-update.rst (6)
11-13: Simplify the introduction for directness and clarity.The introduction could be more concise:
- Line 11: "You have the ability to" can be simplified to "You can"
- Line 13: "as per your requirements" is unnecessarily formal; use "as needed"
- Line 13: Contains a double space before "template"
- The second sentence is wordy and can be streamlined
✏️ Suggested revision
-You have the ability to perform bulk updates for various assessment settings, including points, partial points, use of maximum score, show expected answer, number of attempts, and showing rationale to students. +You can perform bulk updates for various assessment settings, including points, partial points, use of maximum score, show expected answer, number of attempts, and showing rationale to students. -Before you begin, make sure to download the Excel (.xlsx) template file. You can download the Excel (.xlsx) template file for your course from **Download Assessment Template** in the **Assessment Settings** section of the **Bulk Settings** area. Update the fields as per your requirements and use that Excel (.xlsx) file to update the assessment settings. +Before you begin, download the Excel (.xlsx) template file from **Download Assessment Template** in the **Assessment Settings** section of the **Bulk Settings** area. Update the fields as needed and upload the file to apply your changes.
22-24: Remove trailing whitespace for clean formatting.Lines 22-24 contain trailing tab characters at the end of the lines. These should be removed to maintain consistent formatting throughout the document.
✏️ Suggested fix
- - Edit only the white cells with dropdowns or number inputs. - - Leave any cell set to No Change to keep the current published setting. - - Gray cells labeled Not Supported or Restricted cannot be edited for the selected assessment type. + - Edit only the white cells with dropdowns or number inputs. + - Leave any cell set to No Change to keep the current published setting. + - Gray cells labeled Not Supported or Restricted cannot be edited for the selected assessment type. - Save the file in XLSX format before uploading.
29-29: Remove trailing space after the heading.The heading has an extra space after the colon, which should be removed for consistency.
✏️ Suggested fix
-**Template field reference:** +**Template field reference:**
55-57: Fix inconsistent column naming.The row heading "Defined Number of Attempts" includes the word "Defined" while other rows (Points, Show Expected Answer, Show Rationale to Student) do not follow this pattern. Remove "Defined" for consistency.
✏️ Suggested fix
- * - Defined Number of Attempts + * - Number of Attempts - Number of attempts allowed - No, 1-9, No Change, Not Supported
61-63: Clarify when each value range applies.The description "1-99 (attempts), 0-100 (score %), blank otherwise" doesn't clearly explain the relationship between the "Show Rationale to Student" setting and which value range to use. The reader needs explicit guidance on when to use each range.
✏️ Suggested revision
* - Value (for ATTEMPTS/SCORE) - - Numeric threshold for Attempts or Score - - 1-99 (attempts), 0-100 (score %), blank otherwise + - Numeric threshold when "Show Rationale" is set to Attempts or Score + - 1-99 (when using Attempts), 0-100 (when using Score %), leave blank for other options
84-84: Capitalize button text for UI consistency.The confirmation button text should be capitalized to match standard UI conventions and maintain consistency with other UI element references in the documentation.
✏️ Suggested fix
-6. Click **Apply and Done**. A popup window will appear asking you to confirm, click **yes**. +6. Click **Apply and Done**. A popup window will appear asking you to confirm, click **Yes**.source/instructors/setupcourses/courses.rst (1)
30-30: Consider relocating for better logical grouping.The
batch-assessment-updateentry is currently positioned afterbatch-student-taggingand beforeadd-teachers. For improved organization and discoverability, consider placing it immediately afterbulk-assignment-update(line 27) since both features deal with bulk/batch updates to assignment and assessment settings.Additionally, note the naming inconsistency: this PR uses "batch-assessment-update" while a similar feature at line 27 uses "bulk-assignment-update." Consider whether these should follow a consistent naming convention (both "batch-" or both "bulk-").
♻️ Suggested placement adjustment
bulk-assignment-update + batch-assessment-update batch-groups-upload batch-student-tagging - batch-assessment-update add-teachers
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
source/instructors/getstarted/support/changelog.rstsource/instructors/setupcourses/batch-assessment-update.rstsource/instructors/setupcourses/courses.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use
list-table.- 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.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/getstarted/support/changelog.rstsource/instructors/setupcourses/batch-assessment-update.rstsource/instructors/setupcourses/courses.rst
🧠 Learnings (1)
📚 Learning: 2025-12-11T12:13:36.657Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:84-104
Timestamp: 2025-12-11T12:13:36.657Z
Learning: Documented template usage: In Codio coachBot API, use the template syntax {% prompt 'PROMPT_ID' %} within custom extensions to reference organization-level prompts. This pattern should be described in all relevant reStructuredText docs (all .rst files) where prompts are referenced. The template resolves server-side to fetch the prompt text matching PROMPT_ID from the organization's stored prompts; explain this behavior and ensure examples show PROMPT_ID usage for clarity.
Applied to files:
source/instructors/getstarted/support/changelog.rstsource/instructors/setupcourses/batch-assessment-update.rstsource/instructors/setupcourses/courses.rst
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
shajason
reviewed
Jan 14, 2026
Collaborator
shajason
left a comment
shajason
left a comment
There was a problem hiding this comment.
Just a few small things!
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@source/instructors/setupcourses/batch-assessment-update.rst`:
- Line 26: Remove the trailing tab characters on the empty line (the stray
whitespace at the end of the blank line) so the file contains no trailing
whitespace; open source/instructors/setupcourses/batch-assessment-update.rst,
delete the tabs on that blank line and save the file, and optionally run your
editor’s trim-trailing-whitespace or a linter to ensure no other trailing
whitespace remains.
- Line 82: Update the alt text string that currently reads ":alt: Select excel
Batch Update" to capitalize the product name by changing it to ":alt: Select
Excel Batch Update" so the alt attribute uses the correct product
capitalization.
♻️ Duplicate comments (3)
source/instructors/setupcourses/batch-assessment-update.rst (3)
13-13: Reduce repetition and simplify phrasing.The phrase "Excel (.xlsx) template file" appears three times in two sentences, making the text unnecessarily repetitive. Additionally, "as per your requirements" is overly formal.
✏️ Suggested revision
-Before you begin, make sure to download the Excel (.xlsx) template file. You can download the Excel (.xlsx) template file for your course from **Download Assessment Template** in the **Assessment Settings** section of the **Bulk Settings** area. Update the fields as per your requirements and use that Excel (.xlsx) file to update the assessment settings. +Before you begin, download the Excel (.xlsx) template file from **Download Assessment Template** in the **Assessment Settings** section of the **Bulk Settings** area. Update the fields as needed and upload the file to apply your changes.
55-55: Remove "Defined" for consistency.The row heading "Defined Number of Attempts" includes "Defined" while other rows don't follow this pattern. For consistency, use "Number of Attempts" instead.
✏️ Suggested revision
- * - Defined Number of Attempts + * - Number of Attempts - Number of attempts allowed - No, 1-9, No Change, Not Supported
61-63: Clarify value ranges for different settings.The description doesn't clearly explain when to use attempts (1-99) versus score percentage (0-100). Readers need to understand the relationship between the "Show Rationale to Student" setting and which value range applies.
✏️ Suggested revision
* - Value (for ATTEMPTS/SCORE) - - Numeric threshold for Attempts or Score - - 1-99 (attempts), 0-100 (score %), blank otherwise + - Numeric threshold when "Show Rationale" is set to Attempts or Score + - 1-99 (when using Attempts), 0-100 (when using Score %), leave blank for other options
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/batch-assessment-update.rst
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rst
⚙️ CodeRabbit configuration file
**/*.rst: Review files for:
- Consistent formatting (e.g., headings, lists, links).
- Anywhere there are tables, they should use
list-table.- 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.- Make sure to find all improvements on the first pass.
Go through the material multiple times before submitting comments.
Files:
source/instructors/setupcourses/batch-assessment-update.rst
🧠 Learnings (1)
📚 Learning: 2025-12-11T12:13:36.657Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:84-104
Timestamp: 2025-12-11T12:13:36.657Z
Learning: Documented template usage: In Codio coachBot API, use the template syntax {% prompt 'PROMPT_ID' %} within custom extensions to reference organization-level prompts. This pattern should be described in all relevant reStructuredText docs (all .rst files) where prompts are referenced. The template resolves server-side to fetch the prompt text matching PROMPT_ID from the organization's stored prompts; explain this behavior and ensure examples show PROMPT_ID usage for clarity.
Applied to files:
source/instructors/setupcourses/batch-assessment-update.rst
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
shajason
approved these changes
Jan 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.