> 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/readme-files-for-content-entities.md).
# README files for content entities
Documentation is a critical step that assists customers who may use your integration/script/playbook by providing insight into how the content entity is supposed to work. From creating custom playbooks, to providing background information to assist in debugging, it is important to ensure that the documentation explains every aspect of the integration. Documentation is maintained as `README.md` per integration/script/playbook and made available for customers as part of the [reference docs](https://xsoar.pan.dev/docs/reference/index) of the Cortex XSIAM Developer Hub.
We recommend reviewing the [HelloWorld integration README file](https://github.com/demisto/content/blob/master/Packs/HelloWorld/Integrations/HelloWorld/README.md) as you create the README files for your content entities.
{% hint style="info" %}
### Note
[Images](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/images-in-documentation.md) and [videos](/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/videos-in-documentation.md) can be added to documentation.
{% endhint %}
#### Documentation must be generated if:
* If the content entity is new.
* If the content entity exists but is missing documentation.
* If the content entity exists and some of it has changed. For example, a new command was added or context was changed.
**Documentation examples**
* [Azure Sentinel](https://github.com/demisto/content/blob/master/Packs/AzureSentinel/Integrations/AzureSentinel/README.md): Shows how the commands and examples should be presented.
* [Slack v2](https://github.com/demisto/content/blob/master/Packs/Slack/Integrations/Slack/README.md): Shows an example of the troubleshooting section.
* [Get Email From Email Gateway - Mimecast](https://github.com/demisto/content/blob/master//Packs/Mimecast/Playbooks/playbook-Get_Email_From_Email_Gateway_-_Mimecast_README.md): show an embedded playbook image.
* [JSON Feed](https://github.com/demisto/content/blob/master/Packs/FeedJSON/Integrations/FeedJSON/README.md): Shows use of embedding a video.
* [CentrifyVault](https://github.com/demisto/content/blob/master/Packs/CentrifyVault/Integrations/CentrifyVault/README.md): Shows use of embedding a YouTube video.
**Documentation Deployment**
After the pull request with the documentation README file is merged into `master`, it becomes available as part of the Developer Hub, and can be viewed in the [reference docs](https://xsoar.pan.dev/docs/reference/index) section. The site is updated with the latest content on a daily basis. If you wish to preview how the documentation looks at the Developer Hub, before merging to `master`, you can either run locally the content-docs project to preview the Reference Docs site locally or create a PR at the [content-docs repo](https://github.com/demisto/content-docs).
#### Preview by generating reference docs locally (recommended)
Clone or download the [content-docs repo](https://github.com/demisto/content-docs). Follow the instructions at the project's [README](https://github.com/demisto/content-docs/blob/master/README.md) to run the site locally and generate Reference Docs for the content repo you have locally. For example run in the content-docs checkout dir:
```programlisting
CONTENT_REPO_DIR=~/dev/demisto/content npm run reference-docs && npm start
```
#### Preview by creating a PR at the content docs repo
Create a PR at the [content-docs repo](https://github.com/demisto/content-docs) with the same branch name as the PR you are working on in the [content repo](https://github.com/demisto/content-docs). Mention in the PR that it is related to a PR from the content repo. Your PR in the content-docs repo will include a preview link in the GitHub Checks section from deploy/netlify. You can perform a dummy white space change for the PR that will re-trigger the build and create a new preview. Example screenshot for preview link:
**MDX to generate the Markdown file**
We use [MDX](https://mdxjs.com/) for the Markdown generation. MDX is a superset of standard Markdown, but it requires that any HTML used in the document must be JSX compliant. This means all HTML tags need to contain a closing tag. For example don't use `
`, use `
`. Additionally, HTML entities < >, not in code blocks need to be HTML encoded. Use `<` and `>` to encode. As part of the build, the README.md file is validated for MDX compliance.
---
# 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://cortex-docs.paloaltonetworks.com/cortex-xsiam-developer-guide/cortex-xsiam-development-guide/documentation/readme-files-for-content-entities.md?ask=&goal=
```
`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.