> For the complete documentation index, see [llms.txt](https://docs.nuvolos.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.nuvolos.com/how-to-guides/workflows-for-instructors/documenting-your-course.md).

# Document your course

<mark style="color:$primary;">**Outcome**</mark>\
You add a `README.md` file to your course that students see automatically on the space overview, with links and embedded video.

<mark style="color:$primary;">**Before you start**</mark>

* You are an **Instance Editor** or **Space Administrator**.
* You are in the **Current state** of the **Master Instance**.

Any folder in Nuvolos can contain a `README.md` file that is rendered automatically as Markdown by the web UI. The top-level `README.md` in the Master Instance is also displayed on the space overview, making it the natural home for course-level documentation.

#### Edit a README from the web UI

{% stepper %}
{% step %}
Open the Files view of the Master Instance.
{% endstep %}

{% step %}
Locate the `README.md` file you want to edit (or create one with + **NEW**).
{% endstep %}

{% step %}
In the ... Actions menu on the file row, choose **EDIT**.
{% endstep %}

{% step %}
Use the WYSIWYG or source-code editor to write your content in Markdown.
{% endstep %}

{% step %}
Save your changes.
{% endstep %}
{% endstepper %}

{% hint style="info" %}
You can embed videos from streaming providers directly in the README by pasting the embed snippet they provide. This is useful for keeping a running log of recorded lectures that students can review.
{% endhint %}

For full Markdown features supported by Nuvolos - including links to headings via the Anchor button - see [Reference › File storage](/reference/file-system-and-storage.md).


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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/how-to-guides/workflows-for-instructors/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.