# GitBook guides

<h2 align="center">GitBook guides</h2>

<p align="center">Looking to improve your documentation workflows? Our guides are packed with advice, tips and best practices for GitBook and beyond.</p>

<p align="center"><button type="button" class="button primary" data-action="ask" data-icon="gitbook-assistant">Ask a question...</button></p>

### Featured guides

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover-dark data-type="image">Cover image (dark)</th></tr></thead><tbody><tr><td><h4>The complete guide to publishing documentation in GitBook [updated for 2025]</h4></td><td><a href="/files/hmgJUVlkv5LYeDPciiew">/files/hmgJUVlkv5LYeDPciiew</a></td><td><a href="/pages/I5zoKKnt6XBITF2cc838">/pages/I5zoKKnt6XBITF2cc838</a></td><td><a href="/files/ddM2cVc9f79CzL3UP9L2">/files/ddM2cVc9f79CzL3UP9L2</a></td></tr><tr><td><h4>Documentation analytics: which metrics to track and how to measure success</h4></td><td><a href="/files/4nOP3W68o5vwvCKqERnM">/files/4nOP3W68o5vwvCKqERnM</a></td><td><a href="/pages/OykWapcRQTN6cSKDjufw">/pages/OykWapcRQTN6cSKDjufw</a></td><td><a href="/files/2qIHCRT5lMWS9xz2iZ9w">/files/2qIHCRT5lMWS9xz2iZ9w</a></td></tr><tr><td><h4>The seven principles of great API docs and how to apply them</h4></td><td><a href="/files/GG5nCB5aeemo96ldkuM4">/files/GG5nCB5aeemo96ldkuM4</a></td><td><a href="/pages/p108M8YlpCVQnSQzuBnU">/pages/p108M8YlpCVQnSQzuBnU</a></td><td><a href="/files/Zv4MuvM5ozrwliv69411">/files/Zv4MuvM5ozrwliv69411</a></td></tr></tbody></table>

### Categories

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><h3><i class="fa-globe-pointer">:globe-pointer:</i></h3></td><td><h4>Editing &#x26; publishing documentation</h4></td><td>Publish, customize and change site settings</td><td><a href="/pages/3Lwa6E3DoqzVYsDlMkGm">/pages/3Lwa6E3DoqzVYsDlMkGm</a></td></tr><tr><td><h3><i class="fa-brush">:brush:</i></h3></td><td><h4>Customizing your docs site</h4></td><td>How to set your site’s theme, add branding and configure options</td><td><a href="/pages/F5NjRpotwxAJ21JKXu6A">/pages/F5NjRpotwxAJ21JKXu6A</a></td></tr><tr><td><h3><i class="fa-window-restore">:window-restore:</i></h3></td><td><h4>Content organization &#x26; localization</h4></td><td>Improve your site’s layout and structure</td><td><a href="/pages/tfPZqUk0xqiub6fzn5Zo">/pages/tfPZqUk0xqiub6fzn5Zo</a></td></tr><tr><td><h3><i class="fa-brain-circuit">:brain-circuit:</i></h3></td><td><h4>SEO &#x26; LLM optimization</h4></td><td>Tips and best practices for being cited consistently</td><td><a href="/pages/O4Oz5KKNB2r0d3z88Qum">/pages/O4Oz5KKNB2r0d3z88Qum</a></td></tr><tr><td><h3><i class="fa-clipboard-list-check">:clipboard-list-check:</i></h3></td><td><h4>Docs workflow optimization</h4></td><td>Improve the way you and your team work</td><td><a href="/pages/nfbzMOGL3lRSs9nRWnno">/pages/nfbzMOGL3lRSs9nRWnno</a></td></tr><tr><td><h3><i class="fa-rectangle-terminal">:rectangle-terminal:</i></h3></td><td><h4>API documentation</h4></td><td>How to create unbeatable API docs</td><td><a href="/pages/pQHrqZo4mc3Er5dW0xvv">/pages/pQHrqZo4mc3Er5dW0xvv</a></td></tr><tr><td><h3><i class="fa-chart-line-up">:chart-line-up:</i></h3></td><td><h4>Docs analytics</h4></td><td>How to measure success for your docs</td><td><a href="/pages/nNE3jGAfO1TeNdups31d">/pages/nNE3jGAfO1TeNdups31d</a></td></tr><tr><td><h3><i class="fa-users">:users:</i></h3></td><td><h4>Docs personalization &#x26; authentication</h4></td><td>Tailor your docs for specific users &#x26; groups</td><td><a href="/pages/4sjqn6GPMpM22aYJmEJO">/pages/4sjqn6GPMpM22aYJmEJO</a></td></tr><tr><td><h3><i class="fa-octagon-check">:octagon-check:</i></h3></td><td><h4>Best practices</h4></td><td>General tips and advice to improve your docs</td><td><a href="/pages/cjqHzmhBvBwlsxNHogki">/pages/cjqHzmhBvBwlsxNHogki</a></td></tr></tbody></table>

***

### Trending guides

<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><h3><i class="fa-arrow-up">:arrow-up:</i> Most popular</h3></td><td><ul><li><a href="/pages/I5zoKKnt6XBITF2cc838">The complete guide to publishing documentation in GitBook [updated for 2025]</a></li><li><a href="/pages/0ZnDWZAw5K4PiidPbaZf">How to structure technical documentation: best practices</a></li><li><a href="/pages/yH7Mhwm4GPB0eiDOBS2R">Localize your docs with variants in GitBook</a></li><li><a href="/pages/nE7HQxA8bhx2cDMqtwBa">Import or migrate your content to GitBook with Git Sync</a></li><li><a href="/pages/ZYqnks2uLnPy384HMHch">Upload and embed a playable video into your GitBook docs</a></li></ul></td></tr><tr><td><h3><i class="fa-sparkle">:sparkle:</i> Recently added</h3></td><td><ul><li><a href="/pages/yH7Mhwm4GPB0eiDOBS2R">Localize your docs with variants in GitBook</a></li><li><a href="/pages/oYJgM0AzJYWDAVMLMydw">Personalize your GitBook site using URL parameters and adaptive content</a></li><li><a href="/pages/Cjlk0bo1FmbVclhWI7vc">Track advanced analytics with GitBook’s events aggregation API</a></li><li><a href="/pages/TTQYHk921asqVwIgt9dB">Document your API in 5 simple steps</a></li><li><a href="/pages/NuD04RU7M2lc3mVeghuT">Personalize your GitBook site using cookies and adaptive content</a></li></ul></td></tr></tbody></table>


---

# Agent Instructions: 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:

```
GET https://gitbook.com/docs/guides/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.