diff --git a/.coderabbit.yaml b/.coderabbit.yaml index cae3d876..61a0fe52 100644 --- a/.coderabbit.yaml +++ b/.coderabbit.yaml @@ -12,6 +12,9 @@ reviews: poem: false review_status: true collapse_walkthrough: false + sequence_diagrams: false + unit_tests: + enabled: false auto_review: enabled: true drafts: false 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/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..5475459d 100644 --- a/source/instructors/admin/organization/llms.rst +++ b/source/instructors/admin/organization/llms.rst @@ -97,6 +97,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/authoring/guides/custom_button.rst b/source/instructors/authoring/guides/custom_button.rst index 59439fb3..213396de 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 +****************************** + +The **Upload File** button can be used to request learners to upload files to a folder in the file tree. This is useful when you ask for multiple files in different folders: + +.. image:: /img/guides/upload-file-example.png + :alt: Screenshot of Guides with multiple buttons to upload files. + +.. Note:: You don't need to create the folder in advance. If the folder doesn't exist it will be created. + +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) + +Once added to the guides, you can change the name of the button and the folder (and folder path), you can 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..27707926 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 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: .. code:: javascript @@ -152,7 +152,9 @@ 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 then your code, and the last line as three backticks @@ -287,8 +289,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: CollapsibleContent @@ -308,11 +310,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 +321,7 @@ The following is the code used to create the image above. Three code blocks are month: 'January' } } - -.. code:: markdown + ```