# docsfy

> Turn any Git repo into a polished, shareable documentation site in minutes

## Getting Started

- [Generate Your First Docs Site](generate-your-first-docs-site.md): Start docsfy with the fastest Docker-based path, sign in as admin, and generate docs for a repository right away.
- [Configure AI Providers](configure-ai-providers.md): Install and authenticate the Claude, Gemini, or Cursor CLI so documentation generation can run successfully.
- [Install and Run docsfy Without Docker](install-and-run-docsfy-without-docker.md): Set the required environment variables, build the frontend, and start the server and CLI directly on your machine.

## User Guides

- [Generate Documentation](generate-documentation.md): Add a repository, choose branch and model settings, and start a new generation from the dashboard.
- [Track Generation Progress](track-generation-progress.md): Follow real-time status updates, understand each generation stage, and abort a run when needed.
- [Regenerate for New Branches and Models](regenerate-for-new-branches-and-models.md): Create new variants for another branch or model and learn when docsfy reuses existing work.
- [View, Download, and Publish Docs](view-download-and-publish-docs.md): Open the latest or exact variant, download the static site, and host the generated output elsewhere.
- [Manage Users, Roles, and Access](manage-users-roles-and-access.md): Create users, assign roles, rotate passwords, and control who can see each project's docs.
- [Manage docsfy from the CLI](manage-docsfy-from-the-cli.md): Configure a server profile and run health checks, generations, status checks, downloads, and admin tasks from the terminal.
- [Fix Setup and Generation Problems](fix-setup-and-generation-problems.md): Diagnose login failures, provider setup issues, branch validation errors, conflicts, and failed generations.

## Reference

- [Configuration Reference](configuration-reference.md): Look up environment variables, default settings, data locations, cookie options, and CLI profile fields.
- [CLI Command Reference](cli-command-reference.md): Find syntax, flags, defaults, and examples for every docsfy command and subcommand.
- [HTTP API Reference](http-api-reference.md): Find auth requirements, paths, parameters, and responses for models, auth, project, admin, download, and docs routes.
- [WebSocket Reference](websocket-reference.md): Look up connection options and the sync, progress, status_change, and heartbeat messages.
