> For the complete documentation index, see [llms.txt](https://docs.urbit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.urbit.org/build-on-urbit/tools/docs-app.md).

# Docs App

Documentation application for distributing docs with Urbit desks.

The `%docs` app allows you to include documentation with the desks you distribute, making them available for easy browsing by users and developers.

The `%docs` app will automatically detect and publish any docs included with any installed desks. As long as they're in the correct place and of a filetype with appropriate `$mark` conversion methods, they'll be picked up.

A `doc.toc` file may be included in the root of the desk, specifying the files to be included, their `$mark`s, and their titles. See the [Index File](/build-on-urbit/tools/docs-app/index-file.md) section for details.

The files will be in a `/doc` directory in the root of the desk. They may be of any filetype, as long as it has conversion methods to the `%docu` mark used by the `%docs` app. The `%docs` app includes parsers and conversion methods for the following marks by default:

* `%txt` - Ordinary `.txt` text files.
* `%udon` - A markdown-like format that supports embedded hoon.
* `%gmi` - An ultra-minimalist markup format called "gemtext".
* `%html` - An ordinary `.html` file.

For more details of these file formats, as well as details of the `%docu` mark and other format requirements of the `%docs` app, see the [File Format](/build-on-urbit/tools/docs-app/file-format.md) section.

Apart from the `$mark` and location requirements described above, there are no particular restrictions on how you organise your docs, or what docs you include. There are, however, some general recommendations detailed in the [Suggested Structure](/build-on-urbit/tools/docs-app/structure.md) section.

## Dev desk <a href="#dev-desk" id="dev-desk"></a>

To include docs in your own desk, there are a few files you'll need (mark files, etc). These are included in the `/docs-dev` directory in the [github repo](https://github.com/tinnus-napbus/docs-app). These files are all symlinked, so you'll need to clone the whole repo, then copy them across with something like:

```
cp -rL git/docs-app/docs-dev/* /path/to/your/development/desk
```


---

# 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://docs.urbit.org/build-on-urbit/tools/docs-app.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.
