Hosted Docs

RogerIQ can expose a lightweight public docs site for project knowledge.

Public Routes

RouteDescription
/docs/:siteSlugDocs home.
/docs/:siteSlug/search?q=...Public docs search.
/docs/:siteSlug/articles/:articleSlugPublic article.
/docs/:siteSlug/articles/:articleId/ratingHelpful or not helpful feedback.
/docs/:siteSlug/contactCreate a support conversation from docs.

Management Routes

RouteDescription
GET /api/projects/:pid/docs/sitesList docs sites.
POST /api/projects/:pid/docs/sitesCreate a docs site.
PATCH /api/projects/:pid/docs/sites/:siteIdUpdate a docs site.
GET /api/projects/:pid/docs/analyticsView docs analytics.

Analytics

Hosted docs analytics include site views, article views, searches, failed searches, conversations created, deflection rate, helpful feedback, and top articles.

Contact From Docs

Docs contact submissions create support conversations, which keeps docs feedback and customer support in the same queue.

Ask a question... ⌘I