AI Features

AlgoQuill is AI-native — meaning AI is not a bolt-on feature but the foundation the whole product is built on. Here is what each AI feature does and how to use it.

AI Chat Widget

Every AlgoQuill documentation site includes an AI chat widget that visitors can use to ask questions in plain English. The assistant is trained on your specific documentation — it doesn't make up answers, it cites the exact page it drew from.

How to enable it

Go to your project dashboard

Open "AI Chat Config" in the left sidebar

Toggle the chat widget on

Optionally customise: the greeting message, the widget colour, and which pages it can answer questions about

Publish any pages you want it to have access to — the AI only reads published content

Embed on your own site

Add the chat widget to any external site with one script tag. Go to Embed Widget in the dashboard to get your embed code.

What it tracks: Every question asked, which questions got good answers, and which searches returned no results. This data appears in AI Insights.

AI Documentation Generation

AlgoQuill generates complete documentation pages from your codebase. It reads your actual code — not just the README — and produces structured, accurate documentation.

RAG Docs (recommended)

RAG (Retrieval Augmented Generation) works by first indexing your entire repository, then generating docs using the most relevant code chunks as context. This produces more accurate and specific output than sending the full codebase.

Sync your repo

AlgoQuill indexes your codebase into searchable chunks. Run once, re-run when the code changes significantly.

Choose your audience

Developers, Customers, Enterprise/Internal, or Portfolio/Recruiters. Each produces completely different documentation from the same code.

Specify a topic

"Authentication flow", "Payment API", "Database models" — be specific. The more specific the topic, the better the output.

Choose a type

API Reference, Quickstart, Tutorial, or Reference. This determines the structure of the generated page.

Generate and review

AlgoQuill retrieves the most relevant code context, generates the page, and saves it as a draft for your review.

AI Generate (direct)

The AI Generate page lets you generate from a prompt, from GitHub directly, from pasted code, or from an OpenAPI spec. Use this for documentation that doesn't require deep code context — getting started guides, conceptual explanations, migration guides.

Generate Full Suite

The "Generate All" button in RAG Docs generates 5 pages at once: Quickstart Guide, API Reference, Components Overview, Configuration Guide, and Troubleshooting. All saved as drafts for your review.

Important: Generated pages are always saved as drafts. You must manually publish each one. Only published pages are visible on your public documentation site.

Drift Detection

Drift detection compares your published documentation against your current codebase and identifies mismatches. It catches four types of issues:

Outdated

Documentation describes something that has changed — a renamed function, removed parameter, different behaviour.

Missing

Code has functions, endpoints, or components that have no documentation page at all.

Deprecated

Documentation describes something that no longer exists in the codebase.

Inconsistent

Naming or usage in docs doesn't match the code — docs say onClick but code uses onPress.

Go to Drift Detection in the dashboard and click Run Analysis. Results show the specific page affected, the specific code file that caused the issue, and a suggested fix.

AI Insights

AI Insights tracks what visitors ask the chat widget and uses that data to identify gaps in your documentation. The most valuable metrics:

Unanswered questions

Questions the AI couldn't answer confidently — these are your documentation gaps.

Top search queries

What users search for most. If they're searching for it, it needs a dedicated page.

Zero-result searches

Searches that returned nothing — strong signal that content is missing entirely.

Quickstart

Themes & Customization