Get started

This guide takes a new project from empty to a working docs assistant.

1. Create a project

Sign up at knoku.com/signup , create a project, and keep the project ID nearby. The CDN script tag and @knoku/widget npm package both use that ID to fetch the project’s public configuration.

Before embedding the widget in production, open Project settings -> Domains and add every host where the widget will run. Knoku rejects widget traffic from hosts that are not allowlisted.

2. Connect a source

Start with the source that best matches how your docs are maintained.

After the first source is indexed, open Documents and confirm the titles, source URLs, and source groups look right.

3. Embed the widget

The fastest path is the widget builder:

1. Open Project -> Widgets.
2. Create a widget configuration.
3. Copy the generated script tag from the Embed step.
4. Paste it into the layout that renders on every docs page.

For a minimal manual install:

<script
  async
  src="https://cdn.knoku.com/widget.js"
  data-project-id="YOUR_PROJECT_ID"
></script>

Use Doc platforms for framework-specific placement, or Widget installation for the full install checklist.

4. Ask a real question

Open the deployed site and ask a question that should be answerable from your docs. Check three things:

• The widget appears only on allowed hosts.
• The answer cites your indexed documents.
• Source links open real pages.

Then ask something your docs do not cover. A good setup should return a limited, honest answer instead of inventing details.

5. Deploy to more surfaces

Once the widget works, connect the channels that match your workflow:

6. Monitor quality

Use Analytics and Sessions after real traffic starts:

• Questions shows repeated questions and coverage gaps.
• Sources cited shows which documents are actually used.
• Deflection estimates answered vs needs-support outcomes.