The Knowledge Base turns the landing page of your documentation site into a search-first help center. Instead of landing on a table of contents, readers land on a hero with a search bar, suggested queries, and direct access to ask questions in natural language — answered by AI using your own content.
This page shows everything you can configure from the Knowledge Base page in the dashboard sidebar.
What is the Knowledge Base?
When enabled, the KB becomes the first tab your readers see when they visit your documentation site. Think of it as the alternative to the traditional "intro page → browse structure" entry point.
Two patterns you can choose between:
KB disabled (default). Readers land on your first documentation section and browse the sidebar tree to find what they need. Best when your docs are primarily meant to be read top-to-bottom, like a tutorial series.
KB enabled. Readers land on a search-first hub with suggested queries and AI Q&A. Best when readers are coming to find specific answers — typical of support docs, product help centers, and reference-heavy sites.
Both can coexist — the KB doesn't replace your structured sections. Readers who want to browse can still click into any section from the navbar.
Enabling the Knowledge Base
A single master toggle at the top of the Knowledge Base page turns the whole experience on or off.
Label: Enable Knowledge Base
Helper text: Show a public help center with AI-powered search
Default: on
When disabled, all the fields below fade and become non-editable. When enabled, the KB appears as a new tab in your site's navigation. Everything else on this page only applies while the toggle is on.
Configuring the hero
The top of the KB landing page is a hero block with a heading, an optional subtitle, and a search bar. All four fields here are plain text — no Markdown.
| Field | What it shows | Default |
|---|---|---|
| Name | The label for the KB tab in your site navigation. | Help Center |
| Hero Title | The large heading at the top of the KB landing page. | How can we help? |
| Description (optional) | A short subtitle below the hero title. Leave empty for a minimal hero. | empty |
| Search Placeholder | The hint text shown inside the search input before the reader types. | Search for articles... |
Make the Description do double-duty as your differentiator. A single line like "Search the docs or ask our AI anything about our product" sets expectations that readers can type real questions, not just keywords.
Search suggestions
Suggestions appear as clickable chips under the search bar on the landing page. Clicking a chip runs that query immediately. They serve two purposes:
Discovery — surface common topics new users wouldn't know to look for.
Training — show readers the kind of questions they can ask ("How do I reset my password?" vs just "password").
Type a suggestion in the input and press Enter or click the + button to add it. Each suggestion shows as a chip with an ✕ to remove. There's no limit, but keep the list tight — around 5 works well visually.
Good examples:
"How do I connect a GitHub repo?"
"Set up a custom domain"
"Publish my documentation"
"Invite a team member"
"Change theme colors"
Avoid generic one-word suggestions like "pricing" or "setup" — they don't teach the reader that AI search accepts full sentences.
Display options
Two toggles control what appears on the landing page below the hero.
Show Categories
When on, the landing page displays section cards — one tile per top-level section of your documentation (Product Documentation, API Reference, Changelog, etc.). Clicking a card drops the reader into that section's content.
Default: of
When to turn off: if your KB is meant to be purely search-driven and you don't want to expose the underlying section structure on the landing page.
Show Popular Articles
When on, a Popular Articles section appears below the categories, highlighting specific pages you want to promote — or the most-viewed pages by default.
Default: on
Section Title — the heading shown above the list. Default:
Popular Articles.Article selection — a multi-select dropdown listing every page across every section. Pick the ones you want to feature.
Leave the selection empty and GitDocAI will auto-rank articles by view count — great for brand-new sites where you don't yet know what's popular.
Pick articles manually when you want editorial control over what shows up (e.g., pushing your best onboarding guide above a hot-but-niche page).
Start with auto-ranking. After a month of real traffic, review what readers actually opened most, and pin those manually if you want to stabilize the list.
AI Search and Ask AI (for your readers)
The two reader-facing features that make the KB different from a regular landing page aren't configured here — they work out of the box once the KB is enabled.
AI Search
Every query a reader types runs a hybrid search combining traditional full-text matching with semantic (vector) search. The result is that readers find the right content even when their wording doesn't exactly match what's in your docs.
No configuration is required. GitDocAI indexes your content automatically on publish.
Ask AI
Readers can ask full natural-language questions ("How do I set up a custom domain?") and get a grounded answer generated from the content of your docs — with citations linking back to the specific pages the answer came from. Answers stream in real-time as the AI writes them.
This works across all sections of your site, including versioned content: the AI will pull from the reader's currently-active version and, when relevant, hand off to another version's content.
No parameters to tune — the feature is on whenever the KB is enabled.
Saving your changes
The Save button lives in the sticky header at the top of the Knowledge Base page.
An Unsaved badge appears next to the page title as soon as you make a change.
Navigating away with unsaved changes triggers a confirmation warning.
After clicking Save, the button flashes ✓ Saved for two seconds.
Only Admin and Editor roles can modify the Knowledge Base. Viewers see a read-only version of the page with a lock notice.
Seeing the result
There's no embedded live preview on this page — the KB renders inside your published site. After saving, visit your published URL to see the KB landing page with your current configuration.
If your site isn't published yet, you'll still need to go through one publish pass to see the KB live. Any subsequent changes to the KB take effect on the next publish.