AI
Ask AI
Ask AI adds an assistant to your public docs. Readers type a question in plain language and get an answer that is based on the pages of your project.
How it works for readers
- The reader clicks Ask AI in the header of your docs and types a question.
- The assistant looks through your documentation. While it works, the reader sees short status lines such as Looking through all pages or Reading page "Setup".
- The answer is written out live and can contain formatting, lists and code.
- The reader can ask follow-up questions. The assistant remembers the earlier questions of the same conversation.
The assistant knows which page the reader is currently on, so questions like "How do I configure this?" work without naming the topic.
What the assistant can and cannot do
| It can | It cannot |
|---|---|
| Find and read the pages of the project the reader is on | Read other projects or private pages |
| Search all pages by keyword | Browse the internet |
| Read long pages piece by piece | Change your docs |
| Answer based on what is written in your docs | Make decisions or take actions for the reader |
The assistant is instructed to base its answers on your documentation and not to invent facts. If it cannot find an answer, it says so. Good, specific docs lead to good answers.
Turn Ask AI on or off
Ask AI is one of the page elements. Switch it on or off per page, or set it for the whole project with a default value. With Force Off the button never appears.
Tell the assistant who it speaks for
Open Project settings and enter a Company name. The assistant then answers on behalf of that company, for example as "Acme Ltd.". If you leave the field empty, it uses the display name of your project. The Description of your project is also given to the assistant as background.
Availability and usage
Ask AI is only offered when:
- the AI assistant is enabled on the platform, and
- the project owner still has AI usage available.
AI usage is covered by an allowance that comes with your plan and, once it is used up, by prepaid balance on your account. If neither is available, the Ask AI assistant shows a message that it is not available right now, and the rest of your docs keep working normally.
To protect your allowance from misuse, the number of questions per visitor and per project is limited over time.
Privacy
To answer a question, the question and the text of the relevant pages are sent to the AI service that powers the assistant. Questions and answers are stored by GitRead to operate the service and to account for usage. Do not publish confidential information in a project that has Ask AI enabled, unless you are comfortable with it being used to answer readers' questions. Projects that readers cannot open, such as private projects, cannot be queried by visitors.
Tips for better answers
- Use clear page titles and headings. The assistant uses them to find the right page.
- Put one topic on each page instead of one very long page.
- Write complete sentences. Short, vague notes lead to short, vague answers.
- Add a project description that says what the product does and who the docs are for.