> For the complete documentation index, see [llms.txt](https://cortex-docs.paloaltonetworks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.13/configure-cortex-xsoar/playbooks/develop-your-playbook/task-4.-add-inline-documentation.md).

# Task 4. Add inline documentation

Add inline documentation in Cortex XSOAR 8.13 On-prem playbooks.

When creating playbooks, it is a best practice to document your logic so others can follow your process. Inline playbook documentation makes this easy by displaying section header and task details directly within the playbook editor. This improves efficiency by clarifying the intent of each step and ensures workflows are understandable for anyone following the playbook. Playbook creators can attach specific guidance exactly where it is needed, such as adding warnings to individual tasks or summarizing grouped actions in section headers, making it easier to adopt and customize workflows.

How to access inline playbook documentation

1. Open the playbook you want to edit or review in the playbook editor. If the playbook is locked, duplicate or detach it to enable editing.
2. Click the **Info mode** toggle to set inline documentation view mode to one of the following.
   * None: Hides all inline documentation. Choose this for a clean, distraction-free view of the workflow blocks.
   * Headers: Displays only the documentation for Section Headers. This provides a high-level overview of the different phases of your playbook.
   * All tasks: Displays documentation for every task. This provides deeper insights into the specific logic and warnings for each step.
3. To edit header or task documentation, click the header or task you want to edit. Add details either directly in the editor or from the description in the header or task **Details** tab.

   <div data-gb-custom-block data-tag="hint" data-style="info" class="hint hint-info"><p>You cannot add documentation to the top Playbooks Triggered task.</p></div>

![inline-playbook-documentation.png](https://3790991131-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FvksWgzvBZ9ZvAg4dGLrH%2Fuploads%2Fgit-blob-b018af0e2063d5a16dcdea89edcb6e5d07a61130%2F1b5c26ea9a50f138a6edeac2791f3310ad038de61ba6758cfe61c4bc68211d81.png?alt=media)


---

# 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://cortex-docs.paloaltonetworks.com/cortex-xsoar-8-on-prem/8.13/configure-cortex-xsoar/playbooks/develop-your-playbook/task-4.-add-inline-documentation.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.
