> 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/documentation-contributions.md). # Documentation Contributions Our developer docs and reference content docs are open source and hosted on GitHub. The editing experience is integrated via GitHub directly into the pan.dev doc site to make it easy to contribute and suggest improvements. #### Edit an Existing Document To fix small errors and omissions in existing documents we recommend editing the document directly via a pull request (PR). While you can create an issue to report the error, it is often faster and easier to edit the document with the suggested fix via a pull request. Create a pull request to fix a documentation error 1. Most pages include the ![edit-this-page.png](/files/Fx0CSrdTCH5gADGgWJQl) option at the bottom of the page.

Note

If the Edit this page option is not available, it means the page is not open for public contribution. You can still report an issue, but you can not create a pull request with edits.

2. Once the **Edit this page** link is clicked, a new GitHub window opens. The window contains the page in markdown view with an option to edit the page. Click the pencil icon to start editing the page. ![](/files/LAawTfhxDpcC1bOed9Ta)

Note

If the pencil icon is grayed out, you need to log in to your GitHub account or if necessary create an account.

3. Edit the page with your changes. Use the **Preview changes** tab to check the formatting of your changes. 4. Once editing is completed, scroll to the bottom of the page. Enter a title and description for your proposed change and click **Propose changes**. ![](/files/74Eq1vhywoZdUT8i5CVy) 5. After clicking on **Propose changes** you are taken to a new page: **Comparing changes**. On this page you can compare your changes and create a pull request. Click the **Create pull request** button. ![](/files/4NBYYMe0pIwDcqH4uvYq) 6. You are taken to a new page: **Open a pull request**. Edit the title for the pull request and fill out the description of the PR. Click **Create pull request**. ![](/files/xuCCL6g92AUKd09JgtBp) 7. You've created a pull request. A team member will review and merge your PR. If you've made larger changes, you may get feedback or questions via the comments on the PR. #### Reporting a Documentation Issue If you've found an issue with one of our docs and you are not sure how to fix it via a pull request or the edit option is not available, report an issue. Reporting issues helps improve the documentation. 1. You can report an issue for a specific document by clicking the ![report-an-issue.png](/files/7ycObfbfDaMDI0muQwV6) button at the bottom of the page. 2. Once the **Report an issue** button is clicked, a new window from GitHub opens. The window contains GitHub's issue form. Fill out the issue template with a clear and concise description. If applicable, include screenshots to help explain the issue you encountered. Click **Submit new issue**. ![](/files/4WE4QZaqvjWuA8msiDYt) 3. A team member reviews the issue and may ask for additional clarifications via comments on the issue. 4. Once a PR is created, it is linked to the issue. You cam review and comment on the PR. After the PR is merged the issue is resolved and closed. --- # 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/documentation-contributions.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.