> 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-xsiam-developer-guide/cortex-xsiam-development-guide/documentation.md).

# Documentation

Cortex XSIAM documentation best practices for content packs and contributions.

Content pack documentation includes:

* pack\_metadata.json

  Contains the pack description, pack keywords, tags, use-cases, and categories
* Content Pack README.md

  Packs that provide at least one end-to-end use case should contain a detailed README file that will be displayed in the **Details** tab of the pack in Marketplace. The README file can contain external images and videos, as needed.
* README.md files for integrations, scripts, and playbooks.
* Release notes

  Track changes made in specific content entities, such as integrations or playbooks.
* integrationname\_description.md

  Describes how to set up an integration.

Integrations, scripts, and playbooks and their components (i.e., integration command arguments and outputs) have descriptions that show up both within the product and in the **Reference** section of [xsoar.pan.dev](https://xsoar.pan.dev/docs/reference/index).

While designing your contribution, we recommend reviewing the [design best practices](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/readme/design/design-best-practices.md) and [documentation best practices](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/documentation-best-practices.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 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-xsiam-developer-guide/cortex-xsiam-development-guide/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.
