docsfy

Explain what docsfy does, who it is for, and the high-level problem it solves.

Describe the FastAPI app, SQLite storage layer, AI generation pipeline, and static site renderer.

Define projects, variants, owners, roles, sessions, and generated artifacts.

Walk through cloning, planning, page generation, rendering, and ready/error/aborted states.

List Python, uv, git, required AI CLIs/credentials, and mandatory ADMIN_KEY setup.

Show how to install dependencies and run the service locally using the Python project setup.

Document Dockerfile and docker-compose usage, mounted data volume, and health checks.

Guide users from login through generating, monitoring, and opening their first docs site.

Reference all runtime settings such as ADMIN_KEY, AI provider/model, timeouts, and log level.

Explain Claude, Gemini, and Cursor provider options, credentials, and model selection behavior.

Describe DATA_DIR usage, SQLite DB location, project cache paths, and generated site directories.

Cover secure cookie defaults, SameSite behavior, TTL, and local HTTP development adjustments.

Explain how known models are learned from ready variants and used in dashboard model pickers.

Document project listing, filtering, pagination, role-based UI, and generation form behavior.

Show how provider/model variants are created, regenerated with force, and deleted safely.

Explain the status page, polling behavior, stage updates, activity log, and progress bar semantics.

Cover how abort works for active runs and how retry/regeneration works after errors or aborts.

Document variant-specific and latest-variant docs routes plus tar.gz download endpoints.

Explain search modal, theme toggle, callouts, code copy buttons, TOC, and GitHub metadata.

Describe commit diff detection, page-level cache invalidation, and fallback to full regeneration.

Detail Bearer token and session-cookie auth flow, public paths, and protected endpoint behavior.

Define admin, user, and viewer capabilities across UI actions and write-protected APIs.

Document creating users, reserved usernames, deleting users, and admin panel workflows.

Explain owner-scoped project sharing, grant/revoke APIs, and non-owner visibility rules.

Describe self-service and admin-initiated key rotation, validation rules, and session invalidation.

Summarize SSRF checks, path traversal protections, HTML sanitization, and audit logging points.

Reference login/logout endpoints, cookie behavior, and auth requirements for API clients.

Document request schema for generation, provider/model validation, and conflict/error responses.

List endpoints for status, details, deletion, abort, and downloads across project variants.

Reference user CRUD, access grant/revoke/list endpoints, and admin key rotation operations.

Document `/docs` routes for variant-specific and latest-ready documentation file serving.

Describe `/health` and `/api/status` responses for service checks and dashboard polling.

Cover local, containerized, and OpenShift-style non-root runtime considerations.

Explain projects/users/project_access/sessions tables and built-in migration behavior.

Provide guidance for backing up SQLite and generated project artifacts under DATA_DIR.

Document pytest coverage areas, tox usage, pre-commit hooks, mypy, ruff, and secrets scanning.

Describe current automation posture and recommend pipeline steps based on existing tox and hooks.

Map source modules, templates, static assets, tests, and runtime/config files for contributors.

Show where to customize prompts, renderer templates, frontend assets, and generation logic.