OpenFGA is an open source fine-grained authorization solution based on Google's Zanzibar. This repository contains the website and documentation for openfga.dev.
| Content | Source | Publishing |
|---|---|---|
| Product documentation | docs-site/ |
Mintlify at /docs/... |
| Read-only API reference | docs-site/docs.json and the upstream OpenAPI schema |
Mintlify at /docs/api/service/... |
| Home, Project, Community, and Blog | src/, blog/, and static/ |
Docusaurus on GitHub Pages |
Mintlify serves the documentation and API reference at https://openfga.dev/docs. Legacy /api/service URLs and Swagger bookmarks remain supported through the website compatibility page and redirects. Documentation paths requested without /docs (for example, /modeling/overview) redirect to their /docs/... pages.
See the Mintlify contributor guide for authoring, API samples, media, and deployment. The maintenance scripts guide covers generated files, sitemaps, LLM resources, and upstream updates.
Use Node.js 22. Git, Bash, Python 3, and curl are also required for the repository quality checks.
git clone https://github.com/openfga/openfga.dev.git
cd openfga.dev
npm ciInstall Git LFS and hydrate website/Blog media before rendering the website:
git lfs install
git lfs pullIf objects are already downloaded but files still contain pointers, run git lfs checkout. Assets under docs-site/ intentionally use ordinary Git files; see the asset-storage policy.
Run the Mintlify CLI from docs-site/:
cd docs-site
npx mint dev --port 3333Open http://localhost:3333/. Local pages use source-root paths such as /fga and /api/service; Mintlify adds /docs on the configured hosted deployment.
From the repository root:
npm run devOpen http://localhost:3000/. This runs Docusaurus, not the Mintlify docs. Website previews link to docs/API pages at their public URLs.
After editing native sources, run from the repository root:
npm run check:mintlifyContent changes don't need fixture, contract, or deployment-fingerprint updates. API checks require network access and reject an upstream schema that differs from the recorded digest.
The quality workflow runs repository checks, not Mintlify CLI or hosted acceptance. See validation details and limits.
Build and serve the Docusaurus website from the repository root:
npm run build
npm run serveOutput goes to build/; Mintlify deploys docs-site/ separately. GitHub Pages continues publishing gh-pages. Hosting Mintlify at /docs does not require changing the repository's default branch.
Public routing uses Mintlify's dashboard-provided Cloudflare Worker; this repository does not maintain a Worker. Deployment settings and workflow changes remain owner-managed. See the deployment guide.
Website previews use:
https://openfga.dev/pr-preview/pr-[number]/
Use the separate Mintlify deployment preview for product docs and the API reference; they are not included in the Docusaurus preview.
Please review the Contributing Guidelines before sending a PR or opening an issue.
Pull requests target docs-next, the default branch. Content edits, new pages, and fixes follow normal review; they don't need fixture, contract, or deployment-fingerprint updates. See Authoring pages.
If you find a bug or inaccuracy in the documentation content, please report it in this repository's issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. Refer to the security policy for disclosing security issues.
OpenFGA contact@openfga.dev (https://openfga.dev)
Please refer to https://github.com/openfga/rfcs/blob/main/LICENSE for license information.