# Documenting your course

## The readme feature

On any folder level, you may include a file named `README.md` that will be automatically rendered as a documentation of the folder, if written in standard [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) format. The top level `README.md` is automatically rendered on the overview of your instance.

{% hint style="info" %}
You may edit the `README.md` file from the Nuvolos UI, via the text edit feature which has a WYSIWYG and a source code type editor.
{% endhint %}

1. Navigate to the space and instance of interest where the file resides.
2. Confirm that you are in the **CURRENT STATE** of the instance.
3. Locate the file you would like to edit.
4. In **Actions**, select **...** and in the dropdown, pick the **EDIT** option.

You may also embed videos from streaming providers into your readme file, creating a journal of previous lectures for students to review. This can be done by copying the **Embed** snippets provided by the standard streaming services as a link into the readme file.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nuvolos.com/user-guides/education-guides/documenting-your-course.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.