⚡ docsfy

docsfy

Turn any Git repo into a polished docs site you can generate, track, and share in minutes

Get Started →

Getting Started

  • Generate Your First Docs Site

    Get docsfy running with the fastest setup path, sign in as admin, and generate a searchable docs site for your first repository in one short flow.

  • Install and Run docsfy Without Docker

    Run docsfy locally with Python, Node, and the required AI CLIs when you want a non-container setup or a development-friendly workflow.

Explore →

User Guides

  • Generating Documentation

    Start a new run from the web app with the simplest valid inputs and launch documentation generation successfully.

  • Tracking Generation Progress

    Follow live stages, page counts, and activity logs so you can tell when a run is healthy, finished, or needs to be aborted.

  • Viewing and Downloading Docs

    Open a finished docs site, use its search and navigation tools, and download a static copy for offline use or external hosting.

  • Configuring AI Providers and Models

    Choose the right provider and model for each run, understand how server defaults and known models appear in the UI and CLI, and avoid mismatched settings.

  • Regenerating After Code Changes

    Refresh docs after a repository changes, understand when docsfy can reuse existing work, and force a clean rebuild when you need one.

  • Regenerating for New Branches and Models

    Create separate variants for other branches or models, understand how variant reuse works, and open or download the exact version you need.

  • Managing docsfy from the CLI

    Set up the CLI profile and use terminal commands to generate docs, watch live progress, inspect variants, download output, and handle routine workflows without the web app.

  • Managing Users and Access

    Create users, assign admin, user, or viewer roles, rotate keys safely, and grant or revoke project access so teammates only see the docs they should.

  • Fixing Setup and Generation Problems

    Diagnose failed logins, missing AI CLI tools, invalid repo inputs, and stalled or failed generations so you can get runs back to ready state.

Explore →

Reference

  • CLI Command Reference

    Look up the exact syntax, flags, and output behavior for each docsfy command when you need a fast answer.

  • HTTP API and WebSocket Reference

    Find the exact endpoints, auth rules, request shapes, download routes, and real-time message formats you need for integrations or automation.

  • Configuration Reference

    Find the exact settings you need to configure admin access, AI defaults, data storage, cookies, ports, Docker Compose, CLI profiles, and local development behavior.

Explore →
🤖
AI-friendly documentation

This documentation is optimized for AI consumption.