⚡ docsfy

docsfy

Turn any Git repo into a polished, AI-readable documentation site you can browse, share, and download in minutes.

Get Started →

Getting Started

  • Get Started with docsfy

    Set an admin key, start the server, sign in, and generate your first docs site from a Git repository in one short flow.

  • Set Up the CLI

    Create a secure CLI profile, connect it to your docsfy server, and verify that terminal commands can manage your projects.

Explore →

User Guides

  • Generate Documentation

    Submit a repository URL, choose a branch and model, and start a documentation run from the dashboard or API.

  • Configure AI Providers and Models

    Set default generation and vision models, refresh the model catalog, and fix provider authentication before you generate.

  • Track Generation Progress

    Follow generation stages in real time through the dashboard, WebSocket updates, and CLI watch mode so you know what the system is doing.

  • Browse and Download Docs

    Open the latest or variant-specific docs site, download a tarball or extracted copy, and find the AI-readable `llms.txt` outputs.

  • Regenerate After Code Changes

    Update docs after commits, understand when incremental regeneration is enough, and force a full rebuild when you need a clean result.

  • Manage Projects and Variants

    Inspect project variants by branch, provider, and model, then abort, compare, or delete runs without losing track of ownership.

  • Manage Users and Access

    Create users, assign `admin`, `user`, or `viewer` roles, rotate keys, and grant shared access to the right projects.

  • Deploy docsfy

    Run docsfy with persistent storage, healthy sidecar services, and safe server settings whether you use Docker Compose or a direct host setup.

  • Use Repository Images in Generated Docs

    Cover how to add a `docsfy-images/` folder to a repository, provide optional `images.yaml` descriptions, choose vision provider and model settings in the UI or CLI, and verify that generated sites include copied image assets and image-aware content.

Explore →

Recipes

  • Run Common CLI Workflows

    Copy commands for profile setup, watched generations, status by generation ID, flattened downloads, and day-to-day admin operations.

  • Generate Variants by Branch and Model

    Create parallel outputs for release branches or alternate models, then compare or replace variants without wiping a good result.

Explore →

Reference

  • CLI Command Reference

    Look up every `docsfy` command, option, subcommand, and expected output when you need exact syntax.

  • HTTP API and WebSocket Reference

    Look up authentication rules, REST endpoints, WebSocket message types, and document-serving URLs for automation or integrations.

  • Configuration Reference

    Find environment variables, persisted admin settings, data-directory behavior, and default values when configuring or operating docsfy.

Explore →
🤖
AI-friendly documentation

This documentation is optimized for AI consumption.