navieo

Docs Page

Open Docs in the dashboard to manage Markdown pages for the hosted documentation site and the assistant retrieval corpus. Publishing and embedding are separate controls.

Page workspace

The page has a page list, Markdown editor, preview modes, and controls for upload, page creation, and site settings.

  • Rename, duplicate, or delete a page from its list entry.
  • Edit the slug and Markdown body in the editor.
  • Use Edit, Preview, or Split mode while writing.
  • Toggle Published and Embedded independently, then save.
  • Select multiple pages for bulk publish, embed, or delete operations.
  • Use version history to inspect recent content versions. Concurrent dashboard saves use optimistic locking and return a conflict instead of silently replacing a newer version.

New pages begin unpublished and unembedded.

Published versus embedded

  • Published makes the current page available on the hosted docs site.
  • Embedded makes its title and Markdown body available to assistant retrieval.
  • A page can use either flag, both flags, or neither flag.

Unpublished does not mean confidential. The browser SDK uses a publishable app key, and retrieval does not currently apply document-level end-user permissions. Embed only material that is safe for every widget user of that app. Never embed secrets, customer data, privileged operating procedures, or role-restricted content.

Saving and embeddings

When a saved page needs a new embedding, the request waits for the configured embedding provider and stores one vector for the combined page title and content. The page reports synced or failed after the request finishes. A daily embedding budget can reject additional embedding work; retry after the budget resets. Turning embedding off deactivates the page's retrieval vector.

Use focused headings and concise sections for readable documentation, but do not assume that each heading becomes a separate vector.

Markdown upload

Upload up to 20 .md or .markdown files at once. Each file must be no longer than 100,000 characters. The filename becomes the initial slug, and an H1 supplies the title when present. Review publication and embedding settings after import.

GitHub synchronization

Connected repositories can synchronize single-level .navieo/docs/*.md files. The current synchronization model is last-writer-wins per slug, not a three-way merge:

  • inbound repository changes upsert matching cloud pages;
  • full inbound sync can remove repository-sourced pages whose files were deleted;
  • dashboard saves may send an outbound change to the configured GitHub integration.

Choose a primary editing workflow and review integration pull requests. Concurrent repository and dashboard edits are not automatically merged.

Hosted site

Published pages are served at https://<subdomain>.docs.navieo.io/<slug> or https://<custom-domain>/<slug>. Open Settings → Docs Site to configure the subdomain, custom domain verification, primary color, navigation style, theme, site title, and favicon. The hosted site renders the published page hierarchy; it does not currently provide full-text search.