navieo

Common Workflows

Set up a new app

  1. Create an app in the Navieo dashboard.
  2. Copy the publishable key from Settings → General.
  3. Install @navieo/react and mount NavieoProvider or NavieoNextProvider at the application root.
  4. Open Codebase → Connect and connect the repository.
  5. Run Codebase → Scan and confirm routes under Codebase → Knowledge.
  6. Add product Markdown in Docs or commit .navieo/docs/*.md to the connected repository.
  7. Launch one configured authored tour. Try assistant questions after installing a compatible SDK release.

Add documentation for retrieval

From the dashboard, create a page under Docs, write focused Markdown sections, enable embedding, and save. To version documentation with the product, commit Markdown files under .navieo/docs/; connected GitHub sync imports the changed pages.

Embedding status is independent of publication status. A page can inform the assistant without appearing on a hosted documentation site.

Create an authored tour

Open Tours and choose manual creation or the visual authoring flow. Review every route, selector, action, and tooltip before activation. Test the saved tour through its configured suggestion or playTour(slug); question-driven dynamic guidance does not generate or overwrite authored tour steps.

Test authored tours

  1. Launch an authored tour through its suggestion or playTour(slug) and verify each saved step.
  2. Verify Stop and route transitions without allowing Navieo to perform a host business action.
  3. Review tour diagnostics in Analytics.

After the coordinated SDK release, also ask from a route represented in the current scan, confirm the answer is grounded in the expected route or embedded documentation, and review prompt outcomes separately from navigation diagnostics. When a Take me there offer appears, accept it, check the highlighted target, and follow the guide through to its intended destination, finishing any remaining guidance. Try specific requests for both account and project settings, and check that Stop ends the guide. The dashboard's Test Query preview helps inspect answers but cannot show whether guidance works on your actual page.

Diagnose low completion

Use Analytics to inspect available diagnostics. Use Codebase → Knowledge to confirm the route and control were indexed. Live guidance can use a visible, eligible link even if the scan did not map that individual link. Re-scan after meaningful UI changes, check whether the control is hidden or excluded, and report unsupported patterns with a minimal example. Do not remove intentional safety exclusions to force a guide to continue.

Customize or hide the widget

Use Settings → Widget to configure appearance and global visibility. Guidance and live-label sharing are independent settings. Disabling guidance can take up to five minutes across the service; a browser refresh does not make it immediate. See settings.

Validate an integration release

Use a separate beta app and publishable key in staging. Re-scan the staging commit, verify one authored tour, test the widget's configured visibility, and confirm that no production secret key is present in client code or browser requests. Add a grounded-answer check after the coordinated SDK release.