Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 17 additions & 19 deletions source/common/tools/student-virtual-coach.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,50 +7,48 @@
Virtual Coach
=============

The Virtual Coach can help you understand the error messages you have received, gain a better understanding of the assignment prompt, or receive a hint about the next possible steps.
The Virtual Coach can help you understand error messages, gain a better understanding of the assignment prompt, or receive a hint about the next possible steps.

.. note::
Virtual Coach responses may be AI-generated. Always verify suggestions against your assignment, course materials, and instructor guidance.

To open Virtual Coach, click the Chatbot icon at the bottom-right corner of the screen. This icon will only be available if your teachers enable this feature.
To open the Virtual Coach, click the Chatbot icon at the bottom-right corner of the screen. This icon will only be available if your instructor has enabled this feature.


.. image:: /img/chatbot-icon.png
:alt: ChatBot icon at the bottom left corner
.. image:: /img/vc-and-extensions/coach-icon.png
:alt: Virtual Coach icon at the bottom right corner



When you open Virtual Coach, you will see up to three options depending on the settings applied. If there is no guide in the assignment, only error message augmentation will be available.
When you open Virtual Coach, you will see the options your instructor has enabled. If there is no guide in the assignment, only error message augmentation will be available.


.. image:: /img/Hint-Bot.png
:alt: ChatBot window with three options
.. image:: /img/vc-and-extensions/student-view-coach.png
:alt: The student view of Virtual Coach



- **Summarize what I need to do**: This option summarizes the text in the guide on the page and provides you with an enumerated set of steps.
- **Summarize what I need to do**: This option summarizes the instructions and provides you with an enumerated set of steps.



.. image:: /img/Summarise-bot.png
:alt: Summary of the assessment by chatbot
.. image:: /img/vc-and-extensions/student-vc-summary.png
:alt: The student view of an assignment summary in Virtual Coach



- **Explain an error**: Provides detailed explanations of error messages. After clicking this option, you must paste in the error message text you wish to have explained
- **Explain an error**: Provides detailed explanations of error messages. After clicking this option, you must paste in the error message text.


.. image:: /img/Explain-error.png
:alt: Explain an error by chatbot
.. image:: /img/vc-and-extensions/student-vc-error.png
:alt: The student view of an error explanation in Virtual Coach



- **Provide a hint on what to do next**: Provides you with ideas for the next steps you can take to complete your assignment.

.. image:: /img/vc-and-extensions/student-vc-hint.png
:alt: The student view of next steps hints in Virtual Coach

.. image:: /img/chatbot-hint-option.png
:alt: Hint option by chatbot


You can provide feedback on the Virtual Coach’s responses by using the thumbs up icon to vote up or the thumbs down icon to vote down the responses.
You can also resize the chatbot window by dragging the circle that appears at the top left corner.
You can provide feedback on the Virtual Coach’s responses by using the thumbs up or thumbs down icon.
The Virtual Coach window may be resized by dragging the resizing icon in the upper left corner.
Binary file removed source/img/Assignment-settings-Vc.png
Binary file not shown.
Binary file removed source/img/Explain-error.png
Binary file not shown.
Binary file removed source/img/Hint-Bot.png
Binary file not shown.
Binary file removed source/img/Summarise-bot.png
Binary file not shown.
Binary file removed source/img/chatbot-hint-option.png
Binary file not shown.
Binary file removed source/img/chatbot-icon.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed source/img/extensions-virtual-coach.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/vc-and-extensions/coach-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added source/img/vc-and-extensions/student-vc-hint.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions source/instructors/admin/organization/org-extensions.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
.. meta::
:description: Adding custom extensions to your organization

.. _org-extensions:


Custom Organization Extensions
==============================

You can add custom extensions similar to the Virtual Coach extensions supplied by Codio. More information about custom extensions can be found on the :ref:`Virtual Coach <virtual-coach>` page.

1. Click your username in the top-right corner, then select **Organization** from the menu.

2. In the **Organizations** tab, click the name of your organization.

.. image:: /img/class_administration/createanorganization/organizations.png
:alt: My Organizations

3. Click the **Extensions** tab.

.. image:: /img/manage_organization/customextension.png
:alt: Organization Extensions Tab
2 changes: 2 additions & 0 deletions source/instructors/admin/organization/organisation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ Organization settings
gigabox-usage
delete-org
org-contact-url
org-extensions
auto-release-grades
hide-av
student-email
Expand Down Expand Up @@ -52,6 +53,7 @@ The person who creates the organization in Codio is the owner and is given the a
- :ref:`Gigaboxes <gigabox-usage>`
- :ref:`Delete an Organization <delete-org>`
- :ref:`Set Organization Contact URL <org-contact-url>`
- :ref:`Configure Organization Extensions <org-extensions>`
- :ref:`Enable/Disable Release Grade Automatically <auto-release-grades>`
- :ref:`Hide A/V calls <hideav>`
- :ref:`Set up SSO Integration <sso-integration>`
Expand Down
26 changes: 25 additions & 1 deletion source/instructors/admin/organization/prompt-management.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Enter your prompt text and specify the data you want to include as context.
- Click **Create** once you have entered all the information.

.. note::
Files are retrieved dynamically on the server when the assistant is used. If a referenced file is deleted or doesnt exist after the prompt is created, an empty string is sent as context.
Files are retrieved dynamically on the server when the assistant is used. If a referenced file is deleted or doesn't exist after the prompt is created, an empty string is sent as context.

.. image:: /img/manage_organization/promptmanagement.png
:alt: The prompt management dialog
Expand Down Expand Up @@ -111,3 +111,27 @@ Using the Prompt in a Custom Extension
}
})(window.codioIDE, window)


Using Wildcards to Reference Files in Custom Assistants
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can use wildcards to reference files. These are useful when your assignments contain files with different names. Wildcards follow standard glob patterns (e.g., * matches zero or more characters).

.. note:: When multiple files match, the first match in alphabetical order is selected.

Here is an example:

.. code:: none

Here is the question the student is working on:
<assignment>
{{"type": "VARIABLE", "name": "GUIDE_CONTENT"}}
</assignment>
Here's the sample solution for the question:
<solution>
{{"type": "INSTRUCTOR_VIEW", "filepath": ".guides/secure/lab*.py"}}
</solution>
Here's the starter code for the assignment:
<starter>
{{"type": "STARTER_CODE", "filepath": "lab*.py"}}
</starter>
5 changes: 5 additions & 0 deletions source/instructors/getstarted/support/changelog.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,14 @@ We do not report small bug fixes or issues that affect individual users, who we
`[I]` = Update or improvement
`[F]` = New feature

**January 2026**

- `[I] [7th]`: Add a way to :ref:`Enable or disable extensions on a course level <course-coach-settings>`.

**December 2025**

- `[I] [19th]`: Add a way to :ref:`remove any organization member <remove-org-members>`.
- `[I] [18th]`: Added support for wildcards in file names for :ref:`custom assistants <prompt-management>`.
- `[I] [12th]`: Added support for the :ref:`Jupyter Collaboration Extension <jupyter>`.

**November 2025**
Expand Down
Loading