> For the complete documentation index, see [llms.txt](https://synap.ac/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://synap.ac/docs/exams/create-and-manage-exams/3.-configure/instructions.md).

# Instructions

Adding an instruction page to the exam-hall before a user starts their exam

### Pre-exam instructions

These instructions will display on a users exam hall page which also displays the start window, length of exam and other key information.  It will also display the legal terms and proctoring information if relevant.  Users will be able to see this page as soon as they have an attempt generated, provided they have been sent their login information.

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2Fi2bcrDNYiwlVsBpMFmL9%2FScreenshot%202025-01-20%20at%2011.10.10.png?alt=media&amp;token=9bce9800-4215-426e-be64-0ba6a6713678" alt=""><figcaption><p>Exam hall page with instructions and Synoptic guide</p></figcaption></figure>

### In exam instructions

If you are creating a static exam where the source quiz has instructions, these instructions will be pulled from the source quiz.  These can be edited in the exam.

If you are creating a dynamic exam or a static exam where the source quiz has no instructions, you will need to create new in exam instrcutions.

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FvEdmf5B3EeMHwDyNzsHp%2FScreenshot%202025-01-20%20at%2011.12.10.png?alt=media&amp;token=8f497db0-8325-48d1-a442-337cdadb4116" alt=""><figcaption></figcaption></figure>

In exam instructions are also available via the 'i' icon in the right hand menu, throughout the exam

<figure><img src="https://3316915154-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkgvUeCmTPeNouRxGPC%2Fuploads%2FappbYgcq3sHZXrQDRCTC%2FScreenshot%202025-01-20%20at%2011.14.11.png?alt=media&amp;token=9884befc-b33e-46e0-9b1b-489ebd2c60b0" alt="" width="115"><figcaption></figcaption></figure>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://synap.ac/docs/exams/create-and-manage-exams/3.-configure/instructions.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.