diff --git a/.coderabbit.yaml b/.coderabbit.yaml index cae3d876..4f630a6f 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -12,6 +12,7 @@ reviews: poem: false review_status: true collapse_walkthrough: false + sequence_diagrams: false auto_review: enabled: true drafts: false @@ -27,5 +28,8 @@ reviews: Suggest improvements to enhance readability and accessibility. path_filters: - "!**/*.png" + finishing_touches: + unit_tests: + enabled: false chat: auto_reply: true diff --git a/.codio b/.codio index 4d189add..2f56d2a6 100644 --- a/.codio +++ b/.codio @@ -8,6 +8,7 @@ // Preview button configuration "preview": { "Instructor": "https://{{domain}}/build/html/index.html", + "Preview": "https://{{domain}}/build/html/{{path}}/{{filename_no_ext}}.html", "Student": "https://{{domain}}/build/html/student.html", "Visit Ungit": "https://{{domain4000}}/#/repository?path=%2Fhome%2Fcodio%2Fworkspace" diff --git a/source/img/class_administration/grading/assignmentdata.png b/source/img/class_administration/grading/assignmentdata.png new file mode 100644 index 00000000..2659a172 Binary files /dev/null and b/source/img/class_administration/grading/assignmentdata.png differ diff --git a/source/img/guides/upload-file-button.png b/source/img/guides/upload-file-button.png new file mode 100644 index 00000000..0e27bca5 Binary files /dev/null and b/source/img/guides/upload-file-button.png differ diff --git a/source/img/guides/upload-file-example.png b/source/img/guides/upload-file-example.png new file mode 100644 index 00000000..0d5ae833 Binary files /dev/null and b/source/img/guides/upload-file-example.png differ diff --git a/source/instructors/admin/organization/llms.rst b/source/instructors/admin/organization/llms.rst index 2f4d68cc..948308a3 100644 --- a/source/instructors/admin/organization/llms.rst +++ b/source/instructors/admin/organization/llms.rst @@ -24,8 +24,11 @@ We support the following providers: - `Deepinfra `_ + .. _custom_llm_provider: +| + Custom LLM Providers ==================== @@ -97,6 +100,10 @@ The script: curl -X POST $LLM_URL -H "Content-Type: application/json" -d '{"contents": [{"parts":[{"text": "your question here"}]}]}' + +.. Note:: SDKs may require or expect standard environment variables (e.g., `OPENAI_BASE_URL`, `OPENAI_API_KEY`) or explicit values, while `curl` can use the custom names you configure. + + Enabling LLM for Courses ------------------------ diff --git a/source/instructors/admin/orgbilling.rst b/source/instructors/admin/orgbilling.rst index e3a471c0..050706fa 100644 --- a/source/instructors/admin/orgbilling.rst +++ b/source/instructors/admin/orgbilling.rst @@ -32,11 +32,11 @@ To generate an invoice or a quote, follow the steps below: 2. Enter **Promotion Code** (if any). Codes are not case sensitive, valid for new users only, and not for student pay plans. Invalid or expired codes will display a message. -4. Enter **Purchase Order** Number (if applicable) and **Billing Email**. +3. Enter **Purchase Order** Number (if applicable) and **Billing Email**. -5. **Select a Plan** (semester or annual). +4. **Select a Plan** (semester or annual). -6. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided. +5. Click **Generate Invoice** or **Generate Quote**. The document will be sent to the email provided. .. Note:: You can access your invoice from the email, or you can click **View Invoice** from the **Invoice History** section. Pay your invoice at this link. @@ -54,7 +54,8 @@ The option to switch to a **Student Pay plan** where students are prompted to en 3. Students will now be prompted to make a payment when they access their Codio account, whether it be from Codio or from your LMS. -4. To support students in this process, provide them with `this documentation link `__ with specific emphasis to `this section `__ in the event they have problems especially if this may be first time they are trying to purchase online and the transaction may be refused by their bank due to the ever increasing fraud prevention measures card issuers are implementing or guide them to contact help@codio.com. +4. To support students in this process, provide them with `this documentation link `__ with specific emphasis to `this section `__ in the event they have problems especially if this may be first time they are trying to purchase online and the transaction may be refused by their bank due to the ever increasing fraud prevention measures card issuers are implementing or guide them to contact help@codio.com. + Bookstore Pay (Access Codes) ---------------------------- @@ -64,7 +65,8 @@ Only one access code is required per student even if the student is enrolled in Any unsold access codes will remain active and can be used in subsequent semesters. -**1. Determining License Requirements** +Determining License Requirements +-------------------------------- - Determine the number of licenses required based on expected student enrollment - Select the appropriate subscription type: @@ -79,23 +81,25 @@ Any unsold access codes will remain active and can be used in subsequent semeste | Annual | 978-1-7331872-1-3 | +---------------------+-------------------+ -**2. Ordering Process** +Ordering process +---------------- - Communicate the number of licenses required and subscription type to your bookstore. - The bookstore sends an email with this information to accounts@codio.com, including a purchase order if required. Upon receipt of the order, Codio will issue: -- A printable pdf letter to give to each student purchasing a code, providing instructions for code use. +- A printable PDF letter to give to each student purchasing a code, providing instructions for code use. - A CSV file listing all the access code numbers issued in the order. - An invoice for the codes purchased, payable within 30 days of the invoice date. -**3. Bookstore Management Guidelines** +Bookstore Management Guidelines +------------------------------- - Each access code should only be sold once. -- Access codes never expire and are not course specific, allowing them to be sold in future semesters. -- Bookstores should manage the codes like physical stock and can place additional code orders at any time. -- Codes are non-refundable. +- Access codes never expire and are not course-specific, allowing them to be sold in future semesters. +- Bookstores should manage access codes like physical stock and can place additional code orders at any time. +- Access codes are non-refundable. Viewing Invoice History diff --git a/source/instructors/authoring/guides/custom_button.rst b/source/instructors/authoring/guides/custom_button.rst index 59439fb3..69f501df 100644 --- a/source/instructors/authoring/guides/custom_button.rst +++ b/source/instructors/authoring/guides/custom_button.rst @@ -78,6 +78,28 @@ Students can restore current files to the default setting from the :ref:`setting {Button text | reset}(optional commands to run) +Creating an Upload File Button +****************************** + +Use the **Upload File** button to request that learners upload files to a folder in the file tree. This is useful when collecting multiple files across different folders: + +.. image:: /img/guides/upload-file-example.png + :alt: Screenshot of Guides with multiple buttons to upload files. + +.. Note:: You do not need to create the folder in advance. If the folder does not exist, it will be created automatically. + +To create an Upload File button, use the button in the ribbon: + +.. image:: /img/guides/upload-file-button.png + :alt: Button to create an Upload File directive. + +Alternatively, this is the synxtax: + +.. code:: markdown + + {Upload | upload-file}(path/optional) + +After adding the button to your guide, you can change the button label, the folder name, and the folder path. You can also use subfolders. Writing a custom event handler ****************************** diff --git a/source/instructors/authoring/guides/markdown_content.rst b/source/instructors/authoring/guides/markdown_content.rst index b61b5c48..5a5d9fde 100644 --- a/source/instructors/authoring/guides/markdown_content.rst +++ b/source/instructors/authoring/guides/markdown_content.rst @@ -140,7 +140,7 @@ To create a numbered list, you start the line with a `1.` The numbers are automa Code Blocks *********** -If you want to show some code, styled with the courier font, in a box and with syntax highlighting applied you surround your code block with three backticks. For example, the following javascript snippet +If you want to show code in a box with syntax highlighting, surround it with three backticks. For example, the following JavaScript snippet: .. code:: javascript @@ -152,9 +152,13 @@ If you want to show some code, styled with the courier font, in a box and with s is written with the first line as -`` ```js`` +.. code:: markdown + + ```js + // your code... + ``` -then your code, and the last line as three backticks +then your code, and the last line as three backticks. Note that you can specify a language type after the top 3 back ticks. Entering `python` after the backticks would apply syntax highlighting for python. Many languages are supported. See a full list of supported languages `here `_. You should search for your language and then use the `alias` shown. @@ -287,8 +291,8 @@ This can be achieved with collapsible content and the `
` elem Example ------- - .. image:: /img/guides/collapsible.png - :alt: CollapsibleContent +.. image:: /img/guides/collapsible.png + :alt: Collapsible content @@ -308,11 +312,9 @@ The following is the code used to create the image above. Three code blocks are 2. Variable `b` is assigned a value where the left-hand operator looks like a `string` however JavaScript tries to convert it into a number which is successful. 3. In the case of variable `c`, the string can't be converted and the operation returns the value of `NaN` which means _not a number_. If this is then used in subsequent operations the value cascades and the result will also be `NaN`. -.. code:: markdown -
Code Block
- ```js ` + ```js-hide-clipboard const name = { first: 'John', 'last name': 'Doe', @@ -321,8 +323,7 @@ The following is the code used to create the image above. Three code blocks are month: 'January' } } - -.. code:: markdown + ```
diff --git a/source/instructors/getstarted/support/changelog.rst b/source/instructors/getstarted/support/changelog.rst index ab65fad1..23bf90a6 100644 --- a/source/instructors/getstarted/support/changelog.rst +++ b/source/instructors/getstarted/support/changelog.rst @@ -15,7 +15,8 @@ We do not report small bug fixes or issues that affect individual users, who we **October 2025** -- `[I] [9th]`: New guides button for uploading files. +- `[I] [14th]`: Behavior insight information is available in the assignment CSV file. :ref:`Assignment data ` +- `[I] [9th]`: New Guides button for uploading files. **July 2025** diff --git a/source/instructors/setupcourses/assignment-settings/assignment-actions.rst b/source/instructors/setupcourses/assignment-settings/assignment-actions.rst index 33119ef0..6e4e25b2 100644 --- a/source/instructors/setupcourses/assignment-settings/assignment-actions.rst +++ b/source/instructors/setupcourses/assignment-settings/assignment-actions.rst @@ -25,7 +25,7 @@ Open the **Actions** menu to see additional buttons that allow you to run a plag - **Unmark As Complete** - Click this button to clear the **Mark All As Complete**. -- **Download CSV** - Click this button to download a CSV file with student grade data for the assignment. For more information on the data included see :ref:`Export Assignment Data ` +- **Download CSV** - Click this button to download a CSV file with student grade data for the assignment. For more information on the data included, see :ref:`Assignment Data ` - **Reset** - Click this button to clear all student work. This option is used when you have updated an assignment in your course and you need to reset it so all student assignments are updated with the new assignment. You can reset assignments using the **Action > Reset** button, or the menu in the assignment: diff --git a/source/instructors/setupcourses/export-assignment-data.rst b/source/instructors/setupcourses/export-assignment-data.rst index 63f653b7..a8857e8a 100644 --- a/source/instructors/setupcourses/export-assignment-data.rst +++ b/source/instructors/setupcourses/export-assignment-data.rst @@ -4,18 +4,17 @@ .. _export-assignment: -Export Assignment Data -====================== -Use this to export data related to a specific assignment. Exported data includes student workspace files, in a zip archive for each student. If students have completed the assignment there will also be a .csv file with information such as number of assessment attempts, completion date, time spent, final grade and more. +Assignment Data +================ -Follow these steps to export assignment data: +.. image:: /img/class_administration/grading/assignmentdata.png + :alt: Download assignment data -1. Open the course and expand the course module. -2. Click the **Options** menu (the 3 dots on the far right) for the assignment and choose **Export Assignment Data**. - - An email notification is sent when the data is available for download. - - The following data is included in a **.csv** file: +Download CSV +------------ +1. Click the **Overview** tab. +2. Click the **Options** menu (the 3 dots on the far right) for the assignment and choose **Download CSV**. + The following data is included in the **.csv** file: - Student_Name - First_Name @@ -40,12 +39,24 @@ Follow these steps to export assignment data: - Created Date - Completed (True/False) - Completed Date/Time (all instances) + - LTI ID + - behavioral insights (0-5 indicates how many thresholds the student exceeded. A higher number indicates more suspicious behavior.) and for each assessment: + - _Correct (True/False) + - _Answer + - _Attempts - - _Correct (True/False) - - _Answer - - _Attempts +Export Assignment Data +---------------------- +Use this to export data related to a specific assignment. Exported data includes student workspace files, in a zip archive for each student. If students have completed the assignment there will also be a .csv file with information such as number of assessment attempts, completion date, time spent, final grade and more. See the full list in the section above. + +Follow these steps to export assignment data: + +1. Click the **Overview** tab. +2. Click the **Options** menu (the 3 dots on the far right) for the assignment and choose **Export Assignment Data**. + + An email notification is sent when the data is available for download. .. Note:: The data is retained for a maximum of 6 months.