How Kelu reads a page
Kelu converts each page to markdown, splits it into sections at its headings, and indexes each section with the page title and the headings above it:Write headings as questions people ask
Headings are matched against the reader’s question. Make them specific.| Instead of | Write |
|---|---|
## Configuration | ## Configure the retry limit |
## Notes | ## What happens when a webhook delivery fails |
## Advanced | ## Run two schedulers at once |
Keep one topic per page
A page about one thing gives consistent answers. A page that mixes setup, troubleshooting and pricing makes its sections compete for the same question. Split by topic, not by length.Use your readers’ words
Kelu matches exact words as well as meaning.- If customers say “organisation” and you say “workspace”, use both once near the top.
- Paste error messages word for word. A search for
401 invalid signaturefinds a page that contains401 invalid signature.
Format for machines and people
- Put code in code blocks and name the language (
bash,json). Code blocks stay intact and show as code in answers. - Use tables for parameters and options. Each row can then match its own question. Six options in one paragraph cannot.
- State short facts instead of linking to them. “See the authentication guide” answers nothing, because the link does not travel into the answer. Repeat short facts; for long ones, add a one-sentence summary beside the link.
Things that hurt answers
- Empty or generic page titles. The title is added to every section of the page. A hundred sections titled “Documentation” all look alike.
- Navigation, banners and cookie notices. Kelu strips the common ones. Remove the rest with Exclude selectors on the website source.
- Answers that live only in an image. Write the key point as text next to the diagram or screenshot.
- Scanned PDFs. Kelu does not run OCR, so a scan has no text to index. See PDF extraction.
- Marketing pages mixed with reference docs. Move them to their own source group, or leave them out.
Check your work
- After a sync, open the knowledge base’s Playground tab and ask the questions you expect most.
- Open Coverage Gaps to see what readers asked that your content could not answer, most asked first.
- Answer those questions in Q&A, or let Knowledge Maintenance draft them for you.