⚡ docsfy

docsfy

Turn any Git repository into a polished documentation site in minutes

Get Started →

Getting Started

  • Getting Started with docsfy

    Install docsfy, configure your environment, and generate your first documentation site from a Git repository in under five minutes

  • Deploying with Docker

    Run docsfy as a production service using Docker Compose, configure environment variables, and set up persistent storage

Explore →

User Guides

  • Generating Documentation

    Submit a repository via the web dashboard or CLI, choose an AI provider and model, target a specific branch, and monitor generation progress in real time

  • Managing Projects and Variants

    List, inspect, download, abort, and delete documentation projects and their branch/provider/model variants

  • Browsing Generated Documentation

    Navigate the generated documentation site, use the search feature, switch between variants, and share doc URLs with your team

  • Managing Users and Access Control

    Create user accounts, assign roles (admin, user, viewer), grant and revoke project access, and rotate API keys

  • Configuring AI Providers

    Select between Claude, Gemini, and Cursor providers, choose models, set timeouts, and understand the Pi SDK sidecar that routes AI calls

  • Working with Incremental Updates

    Understand how docsfy detects code changes, regenerates only affected pages, and keeps documentation in sync with your repository

  • Using the CLI

    Set up CLI server profiles, authenticate, and run all docsfy operations from the terminal including generate, status, download, and admin commands

  • AI-Readable Documentation with llms.txt

    Explains that every generated documentation site automatically includes llms.txt (a structured index of all pages) and llms-full.txt (the complete documentation content concatenated into a single file) following the llms.txt standard. Covers how to point AI tools, LLM agents, and chatbots at these files to consume your project's documentation, the format and structure of each file, and how to use them for RAG pipelines or AI-assisted development workflows.

Explore →

Recipes

  • Common Workflow Recipes

    Copy-paste patterns for multi-branch documentation, force-regenerating stale docs, downloading and hosting static sites, and automating doc generation in CI/CD

Explore →

Reference

  • REST API Reference

    Complete reference for all API endpoints including authentication, project management, generation, admin operations, and WebSocket real-time updates

  • CLI Command Reference

    Full reference for the docsfy CLI covering all commands, flags, options, and output formats for generate, list, status, delete, abort, download, and admin subcommands

  • Configuration Reference

    All environment variables, server settings, CLI config file format, and Docker Compose options with their defaults and valid values

Explore →
🤖
AI-friendly documentation

This documentation is optimized for AI consumption.