Welcome to the home of the Flipper TypeScript documentation. These guides cover installation, feature flag usage, workspace operations, and contributor workflows for the monorepo.
- Getting started guide
- Workspace command reference
- Adapter guides
- Create a new package
- Documentation upkeep checklist
| Section | Focus | Audience |
|---|---|---|
guides/ |
End-to-end walkthroughs and tutorials | New adopters |
reference/ |
Command, API, and configuration details | Builders |
how-to/ |
Task-focused instructions | Contributors |
contributing/ |
Project processes and expectations | Maintainers |
Whenever you add or change capabilities:
- Update any impacted guides or references.
- Record the change in the relevant release notes or changelog entry.
- Ask a teammate for a documentation review if the updates touch exported APIs.
If you spot something missing or incorrect, open an issue or send a pull request—keeping documentation fresh is a team sport.