Skip to main content

Task guides

Use how-to guides when you need to complete a specific task quickly and you already know the basics.

Task guides

Focused, step-oriented instructions for common DevDocify platform tasks.

Available guides

Add a docset

Create a new product docset directory, configure the sidebar, and wire it into the platform navigation.

Add an API playground

Add an interactive OpenAPI explorer to a docset with pre-filled defaults for fast onboarding.

Configure search

Configure contextual search and push the structured docs and API index to Algolia.

Configure enterprise controls

Set up SAML configuration, RBAC publish checks, assistant quality validation, and analytics schemas.

Add PlantUML diagrams

Add architecture diagrams with fenced PlantUML blocks that render as SVG images.

Deploy

Deploy to Vercel with CI quality gates, or self-host with Docker or the Helm chart for Kubernetes.

Set up the admin dashboard

Configure and run the admin dashboard for portal management, deployment monitoring, analytics, and user access control.