> For the complete documentation index, see [llms.txt](https://docs.pinot.apache.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.pinot.apache.org/release-0.4.0/developers/developers-and-contributors/update-document.md). # Update Documentation Pinot documentation is powered by Gitbook, and a bi-directional Github integration is set up to back up all the changes. The git repo is here: For Pinot Contributor, there are majorly two ways to update the documentations. ## Submit a Pull Request This follows the old fashion of updating documentations. You can checkout [pinot-docs](https://github.com/pinot-contrib/pinot-docs) repo and modify the documentation accordingly then submit a PullRequest for review. Once the PR got merged, the changes will automatically applied to corresponding Gitbook pages. Please note that all Gitbook documentation follows [Markdown Syntax](https://www.markdownguide.org/basic-syntax/). ## Directly Edit on Gitbook Once granted edit permission, contributors could edit any page on Gitbook and then save and merge the changes by themselves. This is one example commit on Github repo to reflect the updates coming from Git book: [Adding Update Document Page Commit](https://github.com/pinot-contrib/pinot-docs/tree/f2ddc3ebc1ec94c66221d3b6b2cb952bee28d3de/pinot-contrib/pinot-docs/commit/76261ec9d7a7e533315459554b3bd7272a1e00c7/README.md). Usually we grant edit permission to committers and active contributors. Please contact admin(Email to with the content you wanna add) to ask for edit permission for Pinot Gitbook. Once granted the permission, you can directly working on [Pinot Gitbook UI](https://app.gitbook.com/@apache-pinot/s/apache-pinot-cookbook/) to modify the documentation, and merge changes. --- # 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://docs.pinot.apache.org/release-0.4.0/developers/developers-and-contributors/update-document.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.