> For the complete documentation index, see [llms.txt](https://guide.graphqleditor.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://guide.graphqleditor.com/graphql-editor/graph/docs-generation.md).

# Markdown Docs

### Browsing the docs

All descriptions inside a schema are rendered with a remark markdown engine. After clicking a type inside the Table of Contents the interface should scroll down to that field in the schema. If you click on the type inside a field in the schema it will also navigate you to the page containing the documentation of the clicked type.

<figure><img src="/files/8o46wkwL7qgByl6NhIIu" alt=""><figcaption></figcaption></figure>

### Editing docs

To edit any field in the docs, click the pencil icon appearing on hover over an element.


---

# 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, and the optional `goal` query parameter:

```
GET https://guide.graphqleditor.com/graphql-editor/graph/docs-generation.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.
