Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

README.md

Flagent Documentation

Feature flags, A/B testing, dynamic configuration. Documentation index.

View locally: Docs use Docsify and load content over the network. Opening docs.html via file:// will show 404. Run a local server from the docs/ folder (not the project root), then open http://localhost:PORT/docs.html. If Home shows the wrong page, hard refresh (Ctrl+Shift+R / Cmd+Shift+R).

cd docs && python3 -m http.server 8080
# open http://localhost:8080/docs.html

Start Here

I want to… Go to
Run Flagent in 5 min Quick Start — set DB and admin env (see Configuration)
Understand why Flagent Why Flagent — value props and comparison
See all SDKs SDKs Overview
Try the API API Reference
Use the Admin UI Frontend UI Guide
Try the UI with demo data Demo Data
Read step-by-step Getting Started
Tutorial: gradual rollout (Ktor) Gradual Rollout New Payment (30 min)
Performance Benchmarks — evaluation API baselines and how to reproduce
30-min Ktor tutorial Gradual Rollout: Ktor Payment

Documentation Structure


Flagent Cloud — Coming Soon

Managed Flagent in the cloud — no setup, no maintenance. Fully managed feature flags and A/B testing as a service. Join the waitlist to get notified when it's available. Home

Blog: Blog index — product updates and guides (e.g. Feature flags the Kotlin way, Self-hosted Flagent + Ktor).


Guides

Topic EN
Getting Started Guide
Configuration Guide
Deployment Guide
Versioning Guide
Compatibility Guide
FAQ Guide
MCP (AI Assistants) Guide
Enterprise Guide
Use Cases Guide
GitOps Guide
Preview Environments Guide
Trunk-Based Development Guide
Build-Time Verification Guide
Declarative UI Guide
VS Code Extension Guide
Publishing Guide
Roadmap Guide
Contributing Guide

API & Examples

Resource Link
OpenAPI Spec api/openapi.yaml
Endpoints Reference api/endpoints.md
SDKs Overview sdks/README.md
Examples examples/README.md
SDK Integration examples/sdk-integration.md — Ktor, Spring, Kotlin, JS, Swift
Tutorial: Gradual Rollout tutorials/gradual-rollout.md
Tutorial: Ktor Payment (30 min) tutorials/gradual-rollout-ktor-payment.md

Architecture & Features

Topic Link
Backend architecture/backend.md
Frontend architecture/frontend.md
Evaluation Spec architecture/evaluation-spec.md
Offline-First SDK features/offline-first-sdk.md
Performance Optimizations features/performance-optimizations.md
Real-Time Updates features/real-time-updates.md
Benchmarks performance/benchmarks.md — Evaluation API: sub-ms to low-ms latency at thousands of req/s; reproduce
Tuning performance/tuning-guide.md

Documentation style and layout

  • styles.css — global UI: navbar, footer, buttons, typography. Single source of truth for header/footer; all pages (index, quickstart, sdk, docs, blog) use the same .navbar and .footer. Do not change nav/footer structure without updating this file.
  • docsify-custom.css — layout and look only for the Docs page (docs.html): fixed sidebar (260px), content area, markdown section typography, GitHub corner size, --docs-navbar-height. No Vue theme; full custom layout.
  • Navbar vs sidebar: Navbar = site-level links (Home, Quick Start, SDKs, API, Docs, Blog). Sidebar (_sidebar.md) = doc tree only (Getting Started, Guides, etc.). No duplicate entries between the two.

Folder Structure

docs/
├── README.md           ← you are here
├── docs.html           # Docs viewer (unified navbar + footer)
├── docsify-custom.css  # Docsify theme overrides
├── quickstart.html     # 5-min start
├── sdk.html            # SDK overview
├── api-docs.html       # Swagger UI
├── _sidebar.md         # Sidebar navigation
├── guides/             # User guides (incl. frontend-ui.md)
├── sdks/               # SDK overview (README.md)
├── examples/           # API + SDK examples
├── api/                # OpenAPI spec
├── architecture/       # Backend, frontend, eval spec
├── features/           # SDK features
├── performance/        # Benchmarks, tuning
├── tutorials/         # Step-by-step tutorials
└── gh_pages/          # Landing (index.html) for GitHub Pages