course settings for extensions and doc for org extensions#450
Merged
course settings for extensions and doc for org extensions#450
Conversation
WalkthroughAdds several instructor-facing documentation pages and updates for Custom Organization and Course-level extensions, extensive Virtual Coach documentation rewrite (wording, images, flows), prompt-management wildcard guidance, and a changelog entry. All changes are documentation-only; no code or public API edits. Changes
Estimated code review effort🎯 4 (Complex) | ⏱️ ~45 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 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: 4
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/org-extensions.rst:
- Around line 21-22: Replace the generic alt text on the image directive in
org-extensions.rst (the .. image:: /img/manage_organization/customextension.png
line) with a specific description of the Extensions tab, e.g., use alt text like
"Extensions tab — Manage Organization extensions" or "Manage Organization:
Extensions tab (custom extensions list)" so the alt accurately reflects the
shown Extensions tab UI.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Around line 73-76: Split the run-on sentence on line 76 into two sentences and
change the preposition "on a course level" to "at the course level";
specifically, modify the sentence that begins "You can enable or disable your
extensions on a :ref:`course level <course-coach-settings>`." to two sentences
such as "You can enable or disable your extensions at the course level. The
course level settings override the assignment level settings, and you will not
be able to turn an extension off for an individual assignment if you have
activated it at the course level." Ensure the :ref:`course level
<course-coach-settings>` cross-reference remains intact.
In @source/instructors/setupcourses/course-coach-settings.rst:
- Around line 14-15: Update the image alt text in the image directive that
currently reads "Organization Settings" to reflect the course-level context;
change the :alt: value in the image directive (the .. image::
/img/course_settings/course-level-extensions.png block) to a clearer phrase such
as "Course-level Extensions Settings" or "Course Settings - Extensions Tab".
- Line 12: Split the long paragraph in course-coach-settings.rst into 2–3
shorter, focused sections: first a brief sentence stating you can enable Codio
Virtual Coach and organization extensions at the course level via the Extensions
tab in the Admin section; second a short sentence calling out the limitation
that extensions enabled at the course level cannot be disabled at the assignment
level; third a sentence or bullet noting alternatives (enable per-assignment or
use the bulk assignment update feature). Keep wording from the original text but
break into separate lines or a bulleted list for readability.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (2)
source/img/course_settings/course-level-extensions.pngis excluded by!**/*.png,!**/*.pngsource/img/manage_organization/customextension.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (6)
source/instructors/admin/organization/org-extensions.rstsource/instructors/admin/organization/organisation.rstsource/instructors/getstarted/support/changelog.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/course-coach-settings.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/getstarted/support/changelog.rstsource/instructors/setupcourses/course-coach-settings.rstsource/instructors/admin/organization/organisation.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/admin/organization/org-extensions.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/getstarted/support/changelog.rstsource/instructors/setupcourses/course-coach-settings.rstsource/instructors/admin/organization/organisation.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/admin/organization/org-extensions.rst
🔇 Additional comments (6)
source/instructors/setupcourses/courses.rst (1)
48-48: LGTM – Proper toctree entry addition.The new
course-coach-settingsentry is correctly formatted with consistent indentation and placement. The entry follows naming conventions and integrates seamlessly into the course setup documentation hierarchy.source/instructors/getstarted/support/changelog.rst (1)
16-18: LGTM – Consistent changelog entry format.The January 2026 entry follows the established changelog format precisely. The
:ref:cross-reference is correctly formatted, and the entry description is clear and aligned with the style of surrounding entries.source/instructors/admin/organization/organisation.rst (2)
25-25: LGTM – Toctree entry properly integrated.The
org-extensionsentry maintains consistent indentation and positioning within the toctree, following the established organizational pattern.
56-56: LGTM – Bullet point consistent with existing style.The new task description for "Configure Organization Extensions" follows the established format of the Organization Owners task list, with proper
:ref:cross-reference formatting and terminology consistency.source/instructors/setupcourses/assignment-settings/virtual-coach.rst (1)
73-76: Cross-reference is properly configured.The
:ref:course-coach-settings`` anchor is correctly defined on line 5 ofsource/instructors/setupcourses/course-coach-settings.rstand is registered in the parent toctree at `source/instructors/setupcourses/courses.rst` (line 48). The documentation link is complete and discoverable.source/instructors/admin/organization/org-extensions.rst (1)
12-22: Instructions lack the steps for actually adding a custom extension.The file ends after step 3 (navigating to the Extensions tab) without showing how to add or configure a custom extension. Since the introduction states "You can add custom extensions," the guide should continue with the necessary steps to complete this task.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 5
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/assignment-settings/virtual-coach.rst (1)
1-2: Update meta description to match document title.The meta description references "Hint-Bot" but the document is titled and focused on "Virtual Coach." Update the meta description to maintain consistency.
:description: Hint-Bot is a quick AI solution for helping students with simple queries. + :description: Virtual Coach is a quick AI solution for helping students with programming tasks.
🤖 Fix all issues with AI agents
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Around line 17-24: Change the phrase "assignments settings" to "assignment
settings" in the introductory sentence and insert a comma before "only error
message augmentation will be available" so the final sentence reads "...in the
assignment, only error message augmentation will be available."; update the two
occurrences in the intro paragraph around the image block (the sentence that
starts "In the assignments settings area..." and the sentence that begins "When
a student clicks...") so grammar and punctuation are corrected.
- Around line 83-90: The two bare URLs (the GitHub account signup URL and the
Codio Extensions GitHub Page URL) should be converted to proper reStructuredText
links; replace each bare URL with an rst inline link using a clear display label
(e.g., "create a GitHub account" and "Codio Extensions GitHub page") so the
links follow the project's documentation style and read naturally in the
sentence, and update the occurrences that reference the GitHub signup URL and
the Codio Extensions repository link.
- Line 176: Remove the obsolete commented-out instructions that start with
"Click on the green `Fork <https://docs.github.com/...>`_ button..." since they
duplicate and are superseded by the "Use This Template" instructions; delete
that entire commented block so only the current "Use This Template" text remains
and ensure surrounding rst markup and whitespace remain valid (no orphaned
punctuation or broken list formatting).
- Around line 215-234: Update the step text that currently reads "Github" to the
correct brand capitalization "GitHub" in the first numbered instruction, and
modify the image directive's alt text from "Development for testing extensions"
to "Development Mode for testing extensions" (the image line using .. image::
and its :alt: attribute).
- Around line 144-162: Replace all occurrences of the UI phrase variants ("upper
right-hand corner" and "upper right hand corner") with the consistent wording
"upper right corner"; change the plain word Extensions at the start of the
"Applying updates..." subsection to use the existing rst cross-ref syntax
:ref:`Extensions <org-extensions>` (matching the earlier usage); and convert the
bare GitHub repository URL that appears in the deploy instructions (the line
where you tell the user to "Paste the URL of your Github repository’s webpage")
into a proper reStructuredText link so it renders as a clickable hyperlink.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
⛔ Files ignored due to path filters (14)
source/img/Assignment-settings-Vc.pngis excluded by!**/*.png,!**/*.pngsource/img/Explain-error.pngis excluded by!**/*.png,!**/*.pngsource/img/Hint-Bot.pngis excluded by!**/*.png,!**/*.pngsource/img/Summarise-bot.pngis excluded by!**/*.png,!**/*.pngsource/img/chatbot-hint-option.pngis excluded by!**/*.png,!**/*.pngsource/img/chatbot-icon.pngis excluded by!**/*.png,!**/*.pngsource/img/extensions-virtual-coach.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/coach-assignment-settings.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/coach-icon.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/preference-extensions.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/student-vc-error.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/student-vc-hint.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/student-vc-summary.pngis excluded by!**/*.png,!**/*.pngsource/img/vc-and-extensions/student-view-coach.pngis excluded by!**/*.png,!**/*.png
📒 Files selected for processing (2)
source/common/tools/student-virtual-coach.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.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/common/tools/student-virtual-coach.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rst
🧠 Learnings (2)
📚 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/common/tools/student-virtual-coach.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
🔇 Additional comments (2)
source/common/tools/student-virtual-coach.rst (2)
1-54: Overall documentation structure and formatting—approved.The student-facing documentation is well-organized, clearly written, and appropriately uses updated image paths (vc-and-extensions/) consistent with the instructor documentation. The language is properly tailored for students (e.g., "Summarize what I need to do" vs the instructor-facing "Summarize Prompt"), and all rst formatting is correct. Apart from the punctuation issue flagged separately, the file requires no structural changes.
23-23: Add missing comma in compound clause.Line 23 is missing a comma: "If there is no guide in the assignment**,** only error message augmentation will be available."
Note: The parallel file (source/instructors/setupcourses/assignment-settings/virtual-coach.rst, line 24) contains the same phrasing issue and should be corrected for consistency.
-If there is no guide in the assignment only error message augmentation will be available. +If there is no guide in the assignment, only error message augmentation will be available.Likely an incorrect or invalid review comment.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 2
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/assignment-settings/virtual-coach.rst (1)
95-95: Correct subject-verb agreement.Line 95 has a subject-verb mismatch: "repositories" is plural but "starts" is singular. Update to agree with the plural subject.
Proposed fix
-2. Choose one of repositories that starts with **custom-assistant-example-<example_name>** +2. Choose one of the repositories that start with **custom-assistant-example-<example_name>**
🤖 Fix all issues with AI agents
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 160: Replace the inconsistent phrase "upper right hand corner" with
"upper right corner" in the sentence "Login to your Codio account, and click on
your username in the upper right hand corner of your screen and select
**Organizations**." so it matches the terminology used elsewhere ("upper right
corner"); ensure punctuation and spacing remain correct after the edit.
- Line 233: Update the incorrect step reference in the Development Mode
instruction line that reads "10. Paste the **index.js** webpage URL that you
copied in Step 1 in the Source Code URL field" by changing "Step 1" to "Step 7"
so it correctly points to where the index.js webpage URL is copied; modify the
text of that specific list item ("10. Paste the **index.js** webpage URL...") to
reference Step 7.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/assignment-settings/virtual-coach.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/assignment-settings/virtual-coach.rst
🧠 Learnings (2)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 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/assignment-settings/virtual-coach.rst
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 4
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (2)
34-38: Inconsistent capitalization of feature names.Line 17 capitalizes these feature names as "Summarize Prompt," "Error Augmentation," and "Next Steps Hint" (with capitals on key words). The bullet list (lines 34–38) uses "Summarize prompt" with lowercase "prompt" and "Next steps hint" with lowercase words. Ensure consistent capitalization throughout the document.
Suggested fix
-- **Summarize prompt**: This option summarizes the text in the guide on the page and provides students with an enumerated set of steps. +- **Summarize Prompt**: This option summarizes the text in the guide on the page and provides students with an enumerated set of steps. -- **Next steps hint**: Provides students with ideas for the next steps they can take to complete their assignment. +- **Next Steps Hint**: Provides students with ideas for the next steps they can take to complete their assignment.
100-112: Consider documenting prompt template syntax for custom assistants.Based on learnings from related PRs, the template syntax
{% prompt 'PROMPT_ID' %}should be documented where organization-level prompts are referenced in custom assistants. This section explains the Coach API and metadata structure but does not explicitly show how to reference organization-level prompts in custom assistant code. Consider adding guidance on using the prompt template syntax if custom assistants should support organization-level prompts.Would you like me to suggest text explaining how to use the prompt template syntax in custom assistants? This would align with the organization extensions feature introduced in this PR.
🤖 Fix all issues with AI agents
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 2: The meta description in the Virtual Coach RST (the ":description:"
line) contradicts the page body by saying "assisting students with revealing
solutions"; update that :description: to match the content (e.g., "Virtual Coach
is an AI tool for assisting students with explanations and hints, not providing
solutions") so the metadata reflects the actual purpose.
- Line 12: The sentence uses "Our Coach feature" while the document title and
elsewhere use "Virtual Coach"; update that phrase to read "our Virtual Coach
feature" (or "Virtual Coach" consistently) so terminology matches throughout,
e.g., change the phrase in the paragraph containing "Our Coach feature, which
generates AI-powered explanations..." to use "Virtual Coach".
- Line 140: The sentence "Now that you have authored and tested your custom AI
assistant, these are the steps to deploy it in your organization:" is slightly
informal; update it to a clearer, more formal instruction such as "Now that you
have authored and tested your custom AI assistant, follow these steps to deploy
it in your organization:" by editing the line in virtual-coach.rst that contains
the original sentence (the step introduction).
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/assignment-settings/virtual-coach.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/assignment-settings/virtual-coach.rst
🧠 Learnings (2)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 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/assignment-settings/virtual-coach.rst
🔇 Additional comments (4)
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (4)
63-63: Verify cross-reference anchor exists.Line 63 references
:ref:Course Coach Log Data `` to documentation that should exist in another file. Confirm that theexport-course-coach-logsanchor is defined in the target documentation file.
70-70: Verify course-level cross-reference anchors.Lines 70 and 78 reference
:ref:Bulk Assignment Updateand `:ref:`course level <course-coach-settings>respectively. Confirm these anchors exist in their target documentation files.Also applies to: 78-78
148-148: Verify new org-extensions cross-reference anchor.Line 148 references
:ref:Extensions `` which is a new anchor introduced in this PR. Confirm that theorg-extensionsanchor is properly defined in the organization extensions documentation being added.
191-191: Verify internal cross-reference anchors.Lines 191 and 194 reference
:ref:Creating a Releaseand `:ref:`Deploying a custom assistant<deploy-your-assistant>respectively. Confirm these internal anchors (defined at lines 114 and 135) are correctly formatted and resolve properly.Also applies to: 194-194
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 2: Fix the typo in the meta description string by removing the duplicate
"V" so the description reads "Virtual Coach is an AI tool for assisting students
with explanations, error messages, and hints." — update the :description: value
where it currently says "VVirtual Coach" to "Virtual Coach".
- Around line 71-72: Reword the two CSV-description lines so they clearly state
that the CSV includes one column for each built-in Virtual Coach assistant plus
additional columns for any custom extensions, and that each column should
contain TRUE to enable or FALSE to disable that assistant for assignments;
update the sentences referencing "Virtual Coach assistants and custom
extensions" and the TRUE/FALSE behavior accordingly in the virtual-coach.rst
content.
- Line 238: Split the long conditional sentence into two clearer sentences:
first say that adding an extension to your account or testing it in Development
mode makes the extension visible only to you, and then add a second sentence
clarifying that this visibility remains limited to you even if you set
"user_type" to "learner" or "all" in metadata.json; preserve the terms
"Development mode", "your account", "user_type", and "metadata.json" exactly as
written.
- Line 56: The sentence on line 56 is redundant; replace "resizing icon" with a
concise term like "resize handle" (or "drag handle") and remove the extra
verbage so it reads e.g. "The Virtual Coach window may be resized using the
resize handle in the upper left corner." Update the text in virtual-coach.rst by
editing the sentence that currently mentions "resizing icon" and "dragging" to
use a single concise term ("resize handle" or "drag handle").
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (1)
source/instructors/setupcourses/assignment-settings/virtual-coach.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/assignment-settings/virtual-coach.rst
🧠 Learnings (2)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 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/assignment-settings/virtual-coach.rst
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
…le. Added information about wildcards to the Prompt management doc
There was a problem hiding this comment.
Actionable comments posted: 11
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/prompt-management.rst:
- Line 120: The ".. Note::" reST directive in the text has two spaces after the
colons (".. Note:: The..."); change it to a single space so it reads ".. Note::
The..." to match RST conventions and maintain consistency.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 44: The phrase "If error output is not directed to the guide" is
ambiguous; replace it with a clearer alternative such as "If error messages are
not automatically captured in the guide" or "If error output does not appear in
the guide panel" so readers understand that errors must be visible in the guide
UI rather than relying on internal terminology; update the sentence to one of
these options and keep the rest of the paragraph unchanged.
- Line 47: The long conditional sentence in virtual-coach.rst is hard to follow;
split it into two clear sentences: first state that if no error message is
provided the student will receive the prompt "The provided text does not look
like an error message. Please paste an error message below.", and second state
that if they still do not provide an error message they will be returned to the
first screen with three buttons. Locate the sentence that begins "If an error
message is not provided..." and replace it with these two separate, simple
sentences for clarity.
- Line 69: The cross-reference in the RST text "Bulk Assignment
Update<bulk-assignment-update>" is missing a space before the angle bracket;
update the reference in virtual-coach.rst so the :ref: role uses a space between
the link text and the target, i.e. change the token to :ref:`Bulk Assignment
Update <bulk-assignment-update>` to fix the syntax.
- Line 77: Split the long sentence into two for clarity: make one sentence
stating that assistants can be enabled or disabled at the course level (e.g.,
"You can enable or disable assistants at the course level.") and a second
sentence explaining the override behavior (e.g., "Course-level settings override
assignment-level settings. If you activate an extension at the course level, you
cannot disable it for individual assignments."), replacing the em dash
construction in the existing paragraph.
- Around line 60-62: Standardize the two reference lines to use the same
phrasing and add the missing article: change the Codio API item that currently
reads "For more information on Codio APIs see:" to "For more information, see"
and adjust punctuation to match the second item; also insert "the" before
"Export tab" in the Course Coach Log Data item so it reads "Export the Course
Coach Log Data from the Export tab..."; update the Codio API reference line that
mentions codio.course.exportCoachData(courseId) and the Course Coach Log Data
line that uses :ref:`Course Coach Log Data <export-course-coach-logs>`
accordingly.
- Around line 10-12: The two long sentences in this doc need splitting for
readability: break the sentence that begins "When Virtual Coach is enabled,
students can use AI to assist them with their programming tasks..." into two
sentences by ending after "programming tasks" and starting a new sentence that
explains the prompts/restrictions; then split the sentence that begins "Codio
conducts extensive research in the field of AI use in computing education..."
into 2–3 sentences separating (a) the research focus, (b) the example use cases
(error messages, summaries, hints), and (c) the observed benefits (improved
completion rates and higher median grades) so each idea is clear and concise.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 10: Replace all occurrences of the misspelled term "Javascript" with the
correct capitalization "JavaScript" in the document (both inline text and
headings) — specifically update the sentence "You can extend the current
capabilities of Coach by adding your own custom assistants as Javascript
extensions." and the other instance noted (previously at line 14) so every
reference uses "JavaScript".
- Line 22: The sentence "Choose one of repositories that starts with
**custom-assistant-example-<example_name>**" is missing the article "the";
update that phrase to "Choose one of the repositories that starts with
**custom-assistant-example-<example_name>**" so the grammar is correct.
- Line 27: Replace the numeral in the sentence "You'll see 2 files in your
repo:" with the spelled-out form; change that line to read "You'll see two files
in your repo:" to follow documentation style for numbers under ten.
- Line 24: Standardize the spacing of the RST Note directives by replacing any
instances of two spaces after the colons in the ".. Note::" directives with a
single space; locate the ".. Note::" occurrences in the document (the directive
text ".. Note::") and ensure each is formatted as ".. Note: " with only one
space following the two colons.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/courses.rstsource/instructors/setupcourses/custom-coach-extensions.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/admin/organization/prompt-management.rstsource/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rst
🧠 Learnings (6)
📚 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/admin/organization/prompt-management.rstsource/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:13:40.724Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:13:40.724Z
Learning: In source/instructors/admin/organization/prompt-management.rst, ensure the Prompt Management feature documentation specifies the three template buttons and their exact functions: 1) Add Variable inserts dynamic variables (examples: open guide page, open file, error message), 2) Add Instructor View sources files from the .guides folder or student workspace with solution file templating, 3) Add Starter Code sources files from the student workspace with no student edits. The guidance should describe expected behavior, data sources, and any UI labels or templates used, so reviewers can verify accuracy and completeness.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), Prompt IDs can only contain uppercase letters, numbers, and underscores.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
🔇 Additional comments (4)
source/instructors/setupcourses/courses.rst (1)
48-49: LGTM!The toctree entries for the new documentation files are properly formatted and aligned with the existing structure.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (3)
55-56: LGTM! Clear and useful information.These two sentences provide helpful information about the feedback mechanism and window resizing. The information is clear and concise.
17-17: LGTM! Clear introduction to the three settings.The sentence effectively introduces the three Virtual Coach features with consistent terminology and proper formatting.
64-78: Section header underlines correctly match title lengths and meet RST standards.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 8
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/prompt-management.rst:
- Line 120: The RST directive "Note" is capitalized but should be lowercase;
change the directive in the prompt-management.rst line that reads ".. Note:: The
first file that matches the wildcard search will be the one selected." to use
the lowercase directive ".. note::" so it follows reStructuredText conventions.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 85: Update the RST directive capitalization by replacing the uppercase
Note directive with a lowercase directive: change ".. Note:: For more
information about creating custom Virtual Coach assistants see :ref:`Custom
Assistants for Virtual Coach <custom-coach-extensions>`." to use ".. note::" so
the directive follows RST conventions (locate the directive text in the
virtual-coach.rst content within assignment-settings).
- Line 59: Change the RST "Note" directive to lowercase to follow
reStructuredText conventions: replace the ".. Note::" directive in
virtual-coach.rst with ".. note::" (the rest of the sentence can remain
unchanged) so the directive name is lowercase.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 136: Change the RST directive "Note::" to lowercase "note::" in the
markup so it follows reStructuredText conventions; update the line containing
the Note directive that explains extension visibility (the paragraph referencing
**user_type** in **metadata.json**) to use "note::" instead of "Note::".
- Line 79: The RST note directive is incorrectly capitalized as ".. Note::";
change the directive to lowercase ".. note::" for the line containing ".. Note::
**This is an experimental feature**. Adding an assistant..." so it follows RST
conventions and renders correctly.
- Line 24: Replace the RST directive ".. Note::" with the lowercase ".. note::"
to follow reStructuredText conventions and also correct the vendor name from
"github" to "GitHub" in the same note text; update the directive line and the
note sentence within the custom-coach-extensions.rst content so the directive is
lowercase and the product name is properly capitalized.
- Line 59: Update the reStructuredText directive and filename typo: change the
RST directive from ".. Note::" to lowercase ".. note::" and replace the
incorrect "metadata.js" filename with "metadata.json" in the sentence
referencing index.js or metadata; ensure the line now reads with ".. note::" and
"metadata.json".
- Around line 10-12: Standardize the capitalization of "GitHub" in the two
sentences that currently say "a Github account" and "signed in to your Github
account" by changing both instances to "GitHub" so the proper noun is used
consistently; leave the existing link text "GitHub documentation" as-is.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.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/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
🧠 Learnings (7)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:13:40.724Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:13:40.724Z
Learning: In source/instructors/admin/organization/prompt-management.rst, ensure the Prompt Management feature documentation specifies the three template buttons and their exact functions: 1) Add Variable inserts dynamic variables (examples: open guide page, open file, error message), 2) Add Instructor View sources files from the .guides folder or student workspace with solution file templating, 3) Add Starter Code sources files from the student workspace with no student edits. The guidance should describe expected behavior, data sources, and any UI labels or templates used, so reviewers can verify accuracy and completeness.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), Prompt IDs can only contain uppercase letters, numbers, and underscores.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 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/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
🔇 Additional comments (9)
source/instructors/admin/organization/prompt-management.rst (2)
36-36: LGTM: Apostrophe fix improves consistency.The change from a curly apostrophe to a straight apostrophe maintains consistency with plain text standards.
114-137: Well-structured wildcard documentation.The new section clearly explains wildcard usage with a practical example demonstrating assignment content, solution files, and starter code references. The note about first-match selection is helpful for users.
source/instructors/setupcourses/custom-coach-extensions.rst (3)
81-91: Clear update workflow documentation.The steps for applying updates after creating a new release are well-structured and easy to follow. Cross-references are properly formatted.
92-101: Well-documented LLM proxy integration.The section clearly explains how to use custom LLMs and provides appropriate links to API documentation and related setup instructions.
102-135: Comprehensive development mode testing guide.The testing workflow is well-documented with clear step-by-step instructions. The cross-references to earlier sections (create a release, deploy your assistant) help users navigate the complete workflow.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (4)
1-27: Strong introduction with research backing.The updated introduction clearly explains Virtual Coach capabilities and appropriately references research findings. The privacy note about Anthropic is valuable for instructors. Terminology is consistent throughout.
29-58: Clear student experience documentation.The descriptions of the student view, three main features (Summarize Prompt, Error Augmentation, Next Steps Hint), and error handling workflow are well-structured and easy to understand. The image references effectively support the text.
61-68: Comprehensive feedback and export guidance.The section clearly explains student feedback mechanisms and provides two well-documented export options with appropriate cross-references.
70-84: Valuable additions for course-level management.The new sections on bulk settings and course settings clearly explain how instructors can manage assistants at scale. The note about course-level overrides is particularly important for users to understand the settings hierarchy.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 12
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/prompt-management.rst:
- Around line 115-120: The "Using Wildcards to Reference Files in Custom
Assistants" section lacks specifics about supported patterns and matching order;
update the paragraph to state that wildcards follow standard glob patterns
(e.g., "*" matches any characters, "?" matches a single character, and "**"
matches across directories) and clarify that when multiple files match the
pattern the first match is chosen in alphabetical order (lexicographic) to make
selection deterministic.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Around line 61-63: The two separate capability sentences about the Virtual
Coach (students can provide feedback via the thumbs up/down icon, and the
Virtual Coach window can be resized by dragging the resize handle in the upper
left corner) should be converted into a bulleted list for clarity and
consistency; update the virtual coach documentation block containing these
sentences to use a short unordered list with one bullet for feedback capability
and one bullet for resizing capability, preserving the exact phrasing and
punctuation.
- Line 59: The text uses curly quotes around the phrase “Explain this error”;
replace them with straight quotes so it reads "Explain this error" to match
documentation style consistency—locate the sentence mentioning Standard and
Advanced Code tests and update the quote characters around Explain this error
accordingly.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 24: Update the sentence in the note that reads "github repositories" to
use the correct capitalization "GitHub repositories" so it matches the other
occurrences (lines mentioning GitHub) and maintains consistency across the
documentation; specifically replace the lowercase "github" in the diffed note
text with "GitHub".
- Line 118: Update the documentation sentence that reads 'Right-click (or
ctrl-click) on it, and select **Preview Static**' to use the standard
capitalization for the keyboard shortcut by replacing "ctrl-click" with
"Ctrl-click" while leaving "index.js" and the surrounding phrasing unchanged.
- Line 48: Replace the curly quotation marks around “Create a new release” with
straight quotes so the line reads "Create a new release"; update the string in
the instructional text in custom-coach-extensions.rst (the line containing
Create a new release) to use ASCII double quotes for consistency with code
documentation.
- Line 136: Replace the bolded reference **metadata.json** with inline literal
formatting `metadata.json` in the note sentence so it uses code/literal markup
consistently (search for the phrase referencing metadata.json in the note about
Development mode and update the formatting), and scan the same document for any
other occurrences of metadata.json to ensure all usages consistently use literal
formatting.
- Line 53: The sentence "write and create a new tag by referring to the tagging
suggestions on the right panel" is redundant and wordy; replace it with a
simplified phrasing such as "create a new tag using the tagging suggestions in
the right panel" so the instruction reads: "On this page, in the tags field,
create a new tag using the tagging suggestions in the right panel. Enter a name
and description for this release, and click on the Publish release button at the
very bottom of the page."
- Line 59: Edit the note sentence to add a serial comma before "or edits" and
wrap the filenames in literal RST formatting: change "index.js or metadata.json"
to "``index.js``, ``metadata.json``" and insert a comma so the clause reads
"updates, or edits" ensuring the full sentence uses the literal formatting for
both filenames and includes the Oxford comma.
- Line 95: The sentence "If you'd prefer sending API requests to your own LLM
(commercial or open-source) instead of Codio's built-in Anthropic LLM, you can
do so by leveraging your Organization Level LLM API keys via Codio's LLM Proxy."
uses the gerund after "prefer"; change it to the infinitive form by replacing
"you'd prefer sending" with "you'd prefer to send" so the sentence reads "If
you'd prefer to send API requests to your own LLM (commercial or open-source)
instead of Codio's built-in Anthropic LLM, you can do so by leveraging your
Organization Level LLM API keys via Codio's LLM Proxy."
- Around line 27-37: Replace the bold formatting for filenames with RST literal
formatting: change occurrences of **metadata.json** and **index.js** to
double-backtick literals (``metadata.json``, ``index.js``) in this section and
any similar file references (e.g., in the bullet list and narrative sentences)
so filenames are presented as code literals per RST conventions; ensure the link
text to the Coach API remains unchanged and that any inline emphasis around
filenames is removed or converted to the literal style.
- Line 10: Standardize terminology and styling: replace all occurrences of
"Coach" with "Virtual Coach" in the document (title, metadata, and body where
inconsistent), capitalize "GitHub" where it appears as "github repositories",
change bolded filenames to literal code formatting for file identifiers like
`metadata.json`, `index.js`, and `user_type` (and any other filenames currently
bolded), and update the keyboard shortcut phrasing from "ctrl-click" to
"Ctrl-click"; apply these edits consistently throughout the file.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.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/custom-coach-extensions.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/admin/organization/prompt-management.rst
🧠 Learnings (7)
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/admin/organization/prompt-management.rst
📚 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/custom-coach-extensions.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:13:40.724Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:13:40.724Z
Learning: In source/instructors/admin/organization/prompt-management.rst, ensure the Prompt Management feature documentation specifies the three template buttons and their exact functions: 1) Add Variable inserts dynamic variables (examples: open guide page, open file, error message), 2) Add Instructor View sources files from the .guides folder or student workspace with solution file templating, 3) Add Starter Code sources files from the student workspace with no student edits. The guidance should describe expected behavior, data sources, and any UI labels or templates used, so reviewers can verify accuracy and completeness.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), Prompt IDs can only contain uppercase letters, numbers, and underscores.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
🔇 Additional comments (3)
source/instructors/admin/organization/prompt-management.rst (1)
124-137: LGTM: Clear wildcard example.The example effectively demonstrates wildcard usage for assignment content, solutions, and starter code with practical file patterns like
lab*.py.source/instructors/setupcourses/assignment-settings/virtual-coach.rst (2)
1-27: LGTM: Clear introduction and settings overview.The meta description, introduction, and explanation of the three Virtual Coach features (Summarize Prompt, Error Augmentation, Next Steps Hint) are clear and well-structured. The image reference and alt text follow proper RST formatting.
70-85: LGTM: Well-structured bulk and course settings sections.The sections on bulk settings and course-level settings are clear, with appropriate cross-references and explanatory notes. The distinction that course-level settings override assignment-level settings is particularly well-explained.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 7
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/prompt-management.rst:
- Around line 124-137: Replace the inconsistent example tag <starter> with the
standardized <starter_code> tag wherever it appears in this prompt example
(matching the earlier usage of <starter_code>), and verify any other examples
use the same <starter_code> tag so all illustrative XML-style tags are
consistent across the document; update both opening/closing or standalone
occurrences to the standardized form.
- Around line 115-120: Update the wildcard documentation text: change the phrase
"* matches any characters" to a more precise wording such as "* matches zero or
more characters" or "* matches any sequence of characters", and revise the note
"first match in alphabetical order is selected" to explicitly state the sort
criteria, e.g., "the first match in case-sensitive alphabetical order by full
file path is selected" (or your chosen case-sensitivity rule).
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 59: The RST note directive contains a duplicated "note::" token ("..
note:: note:: ..."); locate the directive in custom-coach-extensions.rst (the
line beginning with ".. note:: note::") and remove the extra "note::" so it
reads ".. note::" followed by the note text, ensuring correct indentation and
spacing for RST.
- Around line 126-127: Fix the RST image directive indentation: change the
leading spaces before the `:alt:` attribute under the `.. image::
/img/vc-and-extensions/preference-extensions.png` directive from 4 spaces to 3
spaces so the `:alt:` line uses exactly three-space indentation to match the
project's RST style guide.
- Line 95: The opening sentence is long and conflates multiple ideas; split it
into two simpler sentences: first state that you can send API requests to your
own LLM (commercial or open-source) instead of Codio's built-in Anthropic LLM,
and second explain that to do this you should leverage your Organization Level
LLM API keys via Codio's LLM Proxy; replace the original single sentence with
these two clearer, shorter sentences.
- Line 26: The sentence starting with "Click on the green **Use This Template**
button..." is a run-on and uses an improper dash; split it into two sentences
and fix punctuation by replacing the dash with a period (e.g., first sentence:
instruct the user to click the green button or Fork link to create a copy, and
second sentence: state "This will be your own copy of the custom assistant where
you can make edits to the example code to customize your assistant."). Ensure
the `Fork <...>` inline link and bold text remain unchanged and that spacing and
capitalization are correct.
- Around line 27-35: The nested list under "You'll see two files in your repo:"
is mis-indented: ensure the two top-level bullet items are "metadata.json" and
"index.js" as peers, and make the numbered details (1–4) properly nested under
the "metadata.json" bullet; specifically, move the paragraph about "index.js" so
it becomes the second top-level list item (matching the formatting of
``metadata.json``) and indent the numbered sub-items beneath the
``metadata.json`` bullet so they are visually nested and consistently formatted.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (3)
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.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/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
🧠 Learnings (7)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:13:40.724Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:13:40.724Z
Learning: In source/instructors/admin/organization/prompt-management.rst, ensure the Prompt Management feature documentation specifies the three template buttons and their exact functions: 1) Add Variable inserts dynamic variables (examples: open guide page, open file, error message), 2) Add Instructor View sources files from the .guides folder or student workspace with solution file templating, 3) Add Starter Code sources files from the student workspace with no student edits. The guidance should describe expected behavior, data sources, and any UI labels or templates used, so reviewers can verify accuracy and completeness.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), Prompt IDs can only contain uppercase letters, numbers, and underscores.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 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/admin/organization/prompt-management.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
🔇 Additional comments (2)
source/instructors/admin/organization/prompt-management.rst (1)
36-36: LGTM! Proper apostrophe usage.The note correctly uses a proper apostrophe and clearly explains the dynamic file retrieval behavior.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (1)
1-85: Documentation structure and formatting look excellent.The virtual-coach.rst file is well-structured with clear explanations, proper RST syntax, consistent image directive indentation (3 spaces), and appropriate cross-references. The content flows logically from feature descriptions to bulk and course-level settings. No issues found.
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In @source/instructors/admin/organization/prompt-management.rst:
- Around line 114-137: Update the "Using Wildcards to Reference Files in Custom
Assistants" section: replace the vague phrase "files with different names" with
a specific use-case line such as "when file names vary across assignments but
follow a consistent naming pattern (e.g., lab1.py, lab2.py, lab3.py)";
standardize contractions in the example so all lines use the same form (either
"Here is" or "Here's") across the three blocks that include the placeholders
like {"type": "INSTRUCTOR_VIEW", "filepath": ".guides/secure/lab*.py"} and
{"type": "STARTER_CODE", "filepath": "lab*.py"}; and add one clear sentence
stating exactly which glob patterns are supported (for example: "Supported
patterns: *, ?, **, and character classes like [abc]; if only * is supported,
state that explicitly") so readers know whether patterns such as ?, **, or [...]
are available.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 66: Replace the inline single-backtick URL usages at the noted locations
(e.g., the URL in the sentence starting "Navigate to your extension's GitHub
repository..." and the occurrences around lines 95-99) with proper
reStructuredText literal markup using double backticks
(``https://github.com/<your-github-username>/<extension-repository-name>``) or
convert them to an explicit link with a trailing underscore if you intend them
to be a target; also update the LLM Proxy wording to use consistent phrasing
("organization-level" and "log in") where referenced so the terminology is
uniform throughout those sections.
- Around line 35-38: Add a short org-level prompt templating note to the section
that points to index.js: explain that custom assistant code can reference
organization prompts using the server-resolved template pattern {% prompt
'PROMPT_ID' %}, show a minimal inline example usage in the index.js docs text
and state that the placeholder is resolved server-side to the org’s stored
prompt text; update the wording near the index.js/API reference so readers know
to use {% prompt 'PROMPT_ID' %} when they want to pull org-level prompt content
into their assistant.
- Around line 26-34: The RST has over-indented continuation text and nested
bullets under Step 3 and uses curly “smart” quotes for field values; fix by
adjusting the list so the continuation paragraph aligns directly under the
parent list item and nested bullets use consistent RST list indentation (e.g.,
four-space indent for nested list items relative to the parent), and replace
curly quotes with straight quotes or, better, render metadata values as inline
literals using double backticks (e.g., ``"helper"``, ``"learner"``) for fields
in the metadata.json description and ensure index.js remains listed as a
separate file line without extra indentation.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
source/instructors/admin/organization/prompt-management.rstsource/instructors/setupcourses/custom-coach-extensions.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/custom-coach-extensions.rstsource/instructors/admin/organization/prompt-management.rst
🧠 Learnings (6)
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/admin/organization/prompt-management.rst
📚 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/custom-coach-extensions.rstsource/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:13:40.724Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:13:40.724Z
Learning: In source/instructors/admin/organization/prompt-management.rst, ensure the Prompt Management feature documentation specifies the three template buttons and their exact functions: 1) Add Variable inserts dynamic variables (examples: open guide page, open file, error message), 2) Add Instructor View sources files from the .guides folder or student workspace with solution file templating, 3) Add Starter Code sources files from the student workspace with no student edits. The guidance should describe expected behavior, data sources, and any UI labels or templates used, so reviewers can verify accuracy and completeness.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), Prompt IDs can only contain uppercase letters, numbers, and underscores.
Applied to files:
source/instructors/admin/organization/prompt-management.rst
🔇 Additional comments (2)
source/instructors/admin/organization/prompt-management.rst (1)
36-36: Good typographical correction.The apostrophe correction improves the formatting quality of the documentation.
source/instructors/setupcourses/custom-coach-extensions.rst (1)
19-21: All cross-references and image assets are valid. The org-extensions reference resolves correctly, and all four referenced images exist at their specified paths:
/img/codio-extension-virtual-coach.png/img/creating-a-release-virtual-coach.png/img/publish-release-virtual-coach.png/img/vc-and-extensions/preference-extensions.pngImages are properly formatted with appropriate alt text, and cross-references use correct RST syntax throughout the document.
LolaValente
reviewed
Jan 12, 2026
LolaValente
reviewed
Jan 12, 2026
LolaValente
reviewed
Jan 12, 2026
LolaValente
reviewed
Jan 12, 2026
LolaValente
requested changes
Jan 12, 2026
There was a problem hiding this comment.
Actionable comments posted: 29
🤖 Fix all issues with AI agents
In @source/instructors/getstarted/support/changelog.rst:
- Line 23: Update the changelog entry text for "[I] [18th]" to correct the
grammar by changing "files names" to "file names" so the line reads: `[I]
[18th]`: Added support for wildcards in file names for :ref:`custom assistants
<prompt-management>`.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Line 21: Replace the inconsistent term "Coach" with "Virtual Coach" in the
sentence that currently reads "Coach is powered by Anthropic's Claude model..."
— update that string to "Virtual Coach is powered by Anthropic's Claude
model..." so terminology matches the rest of the docs.
- Around line 66-71: Replace the manual "1." and "2." paragraphs with a proper
reStructuredText enumerated list using "#." for each item so rst auto-numbers
them; specifically change the lines describing
codio.course.exportCoachData(courseId) and the Export tab/ :ref:`Course Coach
Log Data <export-course-coach-logs>` into two "#." list items, preserving the
inline code/backticks and link/ref syntax.
- Line 23: The opening sentence is wordy; replace "In the assignment settings,
there are three settings you can toggle to enable the following features:
**Summarize Prompt**, **Error Augmentation**, and **Next Steps Hint**." with a
concise, direct sentence such as "Toggle these assignment settings to enable
Summarize Prompt, Error Augmentation, and Next Steps Hint." to improve
readability and clarity.
- Around line 63-64: Convert the two standalone sentences ("Students can provide
feedback on the Virtual Coach's responses by using the thumbs up or thumbs down
icon." and "The Virtual Coach window may be resized by dragging the resize
handle in the upper left corner.") into a bulleted list for consistency with
other feature descriptions; replace the two separate paragraphs with a single
list item block (e.g., using "-" or "*" bullets in reStructuredText) where each
capability is its own bullet, preserving the original wording and punctuation.
- Line 55: The long sentence at line about student behavior should be split into
two clearer sentences: one stating that if an error message is not provided the
student will receive the message "The provided text does not look like an error
message. Please paste an error message below.", and a second stating that if the
student still does not provide an error message they will be returned to the
first screen with three buttons; update the paragraph in virtual-coach.rst to
replace the single compound sentence with these two concise sentences for
improved readability.
In @source/instructors/setupcourses/course-coach-settings.rst:
- Line 11: Split the long opening sentence into two shorter sentences to improve
readability while preserving the reST cross-references: keep the first sentence
focused on where to go (e.g., "From the **Extensions** tab in the **Admin**
section of your Course menu, you can enable Codio extensions at the course
level.") and the second sentence on what can be enabled (e.g., mention
":ref:`Virtual Coach <virtual-coach>` extensions and custom :ref:`organization
extensions <org-extensions>`"). Ensure both sentences retain the original
emphasis and links.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 118: Update the instruction text that currently reads "This will open the
file" to explicitly state it opens a preview rather than the full file; replace
that phrase with something like "This will open a preview of the file" (or "This
will open a file preview") in the line containing "This will open the file" so
the behavior is described precisely.
- Line 37: The documentation line uses incorrect capitalization "Javascript";
update the text in source/instructors/setupcourses/custom-coach-extensions.rst
so the reference to the language reads "JavaScript" (keep the surrounding link
and the mention of index.js unchanged).
- Line 103: Remove the redundant phrase "to test it" from the sentence "If you'd
like to test your assistant before deploying it to your organization, you can
use the Extension Development Mode to test it." so it reads concisely as "If
you'd like to test your assistant before deploying it to your organization, you
can use the Extension Development Mode." Ensure only that phrase is deleted and
surrounding punctuation/grammar remains correct.
- Line 74: Update the button label text "Ok" to the standardized "OK" in the
sentence that reads "Paste the URL... and click **Ok**." so it becomes "Paste
the URL... and click **OK**." to match UI convention across the docs.
- Line 93: Change the compound adjective "Organization Level" to a hyphenated
form "organization-level" in the sentence so it reads: "You can use your own LLM
(commercial or open-source) instead of Codio's built-in Anthropic LLM by
leveraging your organization-level LLM API keys via Codio's LLM Proxy."
- Line 70: The sentence "Choose an Organization that you're an owner of" is
awkward; replace it with clearer phrasing such as "Choose an organization you
own" or "Choose an Organization you own — this is how you'll set up your
assistant as an extension." Update the line containing that sentence to use one
of these alternatives for improved readability while keeping the rest of the
sentence unchanged.
- Line 116: In the sentence "Now, you should see the ``index.js`` file in the
filetree on the left..." replace the single-word "filetree" with the two-word
term "file tree" so it reads "...see the ``index.js`` file in the file tree on
the left..."; update that occurrence in the custom-coach-extensions.rst content
around the `index.js` mention.
- Line 129: Reorder the instruction sentence so the location comes first for
clarity: change "Paste the contents of the ``metadata.json`` file that you
copied in Step 2 in the **metadata** section, and click **Save changes**." to a
version that starts with the location (for example, "In the **metadata**
section, paste the contents of the ``metadata.json`` file you copied in Step 2,
and click **Save changes**.") and replace the original string in the document.
- Line 57: The phrasing "changes, updates, or edits" is redundant; update the
sentence in the custom-coach-extensions documentation to use a single concise
term by replacing "changes, updates, or edits to your code files (``index.js``
or ``metadata.json``)" with "changes to your code files (``index.js`` or
``metadata.json``)" so the note reads that you must create a new release if
you've made any changes after creating a release.
- Line 46: Replace the curly quotes around the UI label in the sentence
containing "Create a new release" with straight quotes (or remove the quotes
entirely) so the line reads consistently with other documentation; locate the
sentence referencing "Create a new release" in custom-coach-extensions.rst and
update the punctuation accordingly.
- Line 68: The phrase "upper right corner" is inconsistent with "upper-right
corner"; standardize to the compound adjective form "upper-right corner"
throughout the document by replacing occurrences of "upper right corner" with
"upper-right corner" (search for the exact string "upper right corner" and
update it) so compound adjectives before nouns are hyphenated consistently.
- Line 22: Replace the bold fragment **custom-assistant-example-<example_name>**
with inline code-style notation to make it clear it’s a literal repository name
pattern with a placeholder (e.g., `custom-assistant-example-<example_name>`);
ensure the entire pattern is formatted as code and keep the angle-bracket
placeholder intact or document the placeholder meaning immediately after the
code snippet (for example: <example_name> = the specific example identifier).
- Line 98: The sentence contains an extra space before "to," and an exclamation
mark that reads informal; edit the line referencing "Virtual Coach Custom
Assistants `API Reference
<https://codio.github.io/client/codioIDE.coachBot.html#.getLlmProxyDetails>`_
to send requests and fetch responses from your own LLMs!" by removing the double
space before "to" and replacing the exclamation mark with a period, and
optionally rephrase to a more formal tone such as "to send requests and fetch
responses from your own LLMs." to maintain consistent documentation style.
- Line 112: The long instruction sentence should be split into two sentences for
clarity: first state the import action and pasting the copied URL (e.g., "In the
Select your Starting Point section, click Import and paste the URL you copied in
Step 1 into the URL field."), then a second sentence for naming the project in
Add Details (e.g., "Then give your project a name in the Add Details section.").
Make this change to the sentence that begins "In the **Select your Starting
Point** section..." in the doc.
- Around line 27-33: The wording uses the informal "repo" instead of the
project's preferred "repository"; update the sentence "You'll see two files in
your repo:" to "You'll see two files in your repository:" and ensure any other
occurrences in this block referencing metadata.json and index.js use
"repository" for consistency.
- Around line 28-33: The metadata field list in the metadata.json bullet must be
made consistent: convert the numbered sub-items under ``metadata.json`` to use
uniform punctuation and formatting (add a trailing period to each item) and
avoid mixing numbered list and description-list styles; update the entries for
the fields ``name``, ``type``, ``user_type``, and ``component`` so each is a
consistent numbered sentence with a closing period and parallel phrasing, and
ensure the surrounding bullets (including the ``index.js`` line) match the same
list style.
- Around line 100-101: The section heading "Testing Your Custom Assistant Using
Development Mode" has an underline that's one character too short; update the
underline (the line of hyphens directly beneath the title) so its length exactly
matches the number of characters in the heading (including spaces) by adding one
additional hyphen to that underline.
- Line 64: The sentence "Now that you have authored and tested your custom AI
assistant," is premature because testing appears later; either move the testing
section before the deployment section or change that sentence to remove "and
tested" (e.g., "Now that you have authored your custom AI assistant, follow
these steps to deploy it in your organization:") so the document flow is
consistent; update any cross-references or section order accordingly to ensure
testing instructions precede deployment if you choose to reorder.
- Around line 14-15: The heading "Customize or Use an Existing Custom Assistant
as a JavaScript Extension" has an underline one character short; update the
underline (the line of hyphens directly below that title) to be exactly the same
length as the title (72 characters) so the underline matches the title length.
- Around line 79-80: The section title "Applying Updates to a Custom Assistant
After Creating a New Release" has an underline of dashes that is one character
shorter than the title; update the underline (the line of '-' immediately below
that heading) so its length exactly matches the number of characters in the
title string, ensuring the RST section underline length matches the title.
- Around line 90-91: The section heading "Using Your Own LLMs in Custom
Assistants via Codio's LLM Proxy" has an underline one character too short;
update the underline line of hyphens to match the exact character length of the
heading text (add one more '-' so the underline length equals the heading string
length) to fix the RST underline length mismatch.
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
source/instructors/getstarted/support/changelog.rstsource/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/course-coach-settings.rstsource/instructors/setupcourses/custom-coach-extensions.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/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/course-coach-settings.rstsource/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/getstarted/support/changelog.rst
🧠 Learnings (6)
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 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/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/course-coach-settings.rstsource/instructors/setupcourses/custom-coach-extensions.rstsource/instructors/getstarted/support/changelog.rst
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2026-01-12T23:17:19.618Z
Learnt from: shajason
Repo: codio/knowledge PR: 450
File: source/instructors/admin/organization/prompt-management.rst:124-137
Timestamp: 2026-01-12T23:17:19.618Z
Learning: In prompt management documentation (source/instructors/admin/organization/prompt-management.rst), the XML-style tags `<starter>` and `<starter_code>` are both used intentionally and should not be standardized—they serve different purposes or contexts in the prompt examples.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
🔇 Additional comments (3)
source/instructors/setupcourses/custom-coach-extensions.rst (2)
7-8: Critical: Section underline length mismatchThe underline on line 8 is one character short. RST requires the underline to be at least as long as the title.
- Title "Custom Assistants for Virtual Coach" = 36 characters
- Underline = 35 characters
This will cause RST build errors.
🔧 Proposed fix
Custom Assistants for Virtual Coach -=================================== +====================================Likely an incorrect or invalid review comment.
41-42: Critical: Section underline length mismatchThe underline is one character short.
🔧 Proposed fix
Creating a Release -~~~~~~~~~~~~~~~~~~ +~~~~~~~~~~~~~~~~~~~Likely an incorrect or invalid review comment.
source/instructors/setupcourses/course-coach-settings.rst (1)
8-9: Critical: Section underline length mismatchThe underline on line 9 is one character short. RST requires the underline to be at least as long as the title text.
- Title "Extension Settings for a Course" = 32 characters
- Underline = 31 characters
This will cause RST build errors.
🔧 Proposed fix
Extension Settings for a Course -=============================== +================================Likely an incorrect or invalid review comment.
source/instructors/setupcourses/assignment-settings/virtual-coach.rst
Outdated
Show resolved
Hide resolved
…derline lengths and other misc rewordings
There was a problem hiding this comment.
Actionable comments posted: 5
🤖 Fix all issues with AI agents
In @source/instructors/getstarted/support/changelog.rst:
- Line 18: Changelog entry "[I] [7th]": fix capitalization inconsistency by
changing "Enable" to lowercase "enable" in the sentence "`Add a way to
:ref:`Enable or disable extensions on a course level <course-coach-settings>`"
so it matches the style of other entries (e.g., the "remove" example); update
the text in source/instructors/getstarted/support/changelog.rst for the entry
labeled "[I] [7th]" and confirm the :ref:`course-coach-settings` link still
resolves.
In @source/instructors/setupcourses/assignment-settings/virtual-coach.rst:
- Around line 25-29: Standardize the three feature descriptions to use a concise
verb-first format: change "**Summarize Prompt**: This option summarizes the
text..." to "Summarizes the text in the guide and provides students with an
enumerated set of steps.", change "**Error Augmentation**: Provides detailed
explanations..." to "Provides detailed explanations of error messages.", and
change "**Next Steps Hint**: Provides students with ideas..." to "Provides ideas
for next steps students can take to complete their assignment." Ensure you
update the lines referencing "Summarize Prompt", "Error Augmentation", and "Next
Steps Hint" so all three begin with the verb form for consistent style.
In @source/instructors/setupcourses/custom-coach-extensions.rst:
- Line 131: Update the sentence at line containing "Now you can open any of your
assignments or projects and your extension will be visible as a menu item in
Virtual Coach." by inserting a comma after "projects" so it reads "Now you can
open any of your assignments or projects, and your extension will be visible as
a menu item in Virtual Coach." to improve readability.
- Line 64: The sentence "Now that you have authored and tested your custom AI
assistant," incorrectly presumes testing has already occurred; either move the
testing section (currently at the later "testing" block) so it appears before
this deployment section, or revise this line to "Now that you have authored your
custom AI assistant" and append a short parenthetical like "(testing is optional
and covered in the Testing section below)" to avoid implying tests were
completed; update any cross-references/headings accordingly (refer to the
"testing" section surrounding lines ~100–131) so readers are guided to run tests
before deployment if desired.
- Line 22: Clarify the placeholder syntax in the repository pattern by replacing
or augmenting "custom-assistant-example-<example_name>" with an explicit note or
wildcard form; for example change the text to
"custom-assistant-example-<example_name> (where <example_name> represents
different example types)" or to "custom-assistant-example-*" so readers
understand the angle-bracket denotes a placeholder rather than literal
characters.
📜 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/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.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/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
🧠 Learnings (6)
📚 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/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), the three template buttons have specific functions: Add Variable (dynamic variables like open guide page, open file, error message), Add Instructor View (files from .guides folder or student workspace with solution file templating), and Add Starter Code (files from student workspace with no student edits).
Applied to files:
source/instructors/setupcourses/assignment-settings/virtual-coach.rstsource/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-10-27T17:55:37.142Z
Learnt from: LolaValente
Repo: codio/knowledge PR: 426
File: source/instructors/authoring/assessments/llm-based-rubric.rst:61-61
Timestamp: 2025-10-27T17:55:37.142Z
Learning: In rst files for the Codio knowledge repository, image directive attributes (`:height:`, `:alt:`, etc.) should be indented with 3 spaces, not 4. Content following an image directive should not be indented unless it's intentionally part of that directive.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), files referenced in prompts are retrieved dynamically server-side when the assistant is used, not at prompt creation time.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2025-12-11T12:14:03.649Z
Learnt from: mohitchandarana
Repo: codio/knowledge PR: 445
File: source/instructors/admin/organization/prompt-management.rst:0-0
Timestamp: 2025-12-11T12:14:03.649Z
Learning: In Prompt Management feature (source/instructors/admin/organization/prompt-management.rst), if a referenced file is deleted or doesn't exist when the prompt is used, an empty string is sent as context.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
📚 Learning: 2026-01-12T23:17:19.618Z
Learnt from: shajason
Repo: codio/knowledge PR: 450
File: source/instructors/admin/organization/prompt-management.rst:124-137
Timestamp: 2026-01-12T23:17:19.618Z
Learning: In prompt management documentation (source/instructors/admin/organization/prompt-management.rst), the XML-style tags `<starter>` and `<starter_code>` are both used intentionally and should not be standardized—they serve different purposes or contexts in the prompt examples.
Applied to files:
source/instructors/setupcourses/custom-coach-extensions.rst
🔇 Additional comments (1)
source/instructors/setupcourses/assignment-settings/virtual-coach.rst (1)
1-87: Overall: Clear, well-structured documentation with consistent terminology.The Virtual Coach documentation is well-organized and provides clear instructions for both students and instructors. The updated terminology, images, and cross-references are consistent throughout. The privacy note and research citation add credibility. The new bulk and course-level settings sections integrate smoothly with the existing content.
LolaValente
approved these changes
Jan 13, 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
New Features
Documentation
Guidance
✏️ Tip: You can customize this high-level summary in your review settings.