Handbook
How this handbook is organised and the rules for contributing to it.
Handbook
This handbook is the source of truth for product strategy and architecture. It
lives in the repository's docs/ folder and is rendered by apps/docs.
How the handbook is organised
| Section | What you will find |
|---|---|
| Design | The glass design system contract that binds tooling/tailwind, packages/ui, and the apps. |
| ADRs | Architecture Decision Records. |
Product documents — vision, modules, architecture, domain model, business
model, compliance, roadmap, go-to-market, and open questions — are written per
project as docs/NN-<topic>.md and registered in meta.json in the order they
should appear.
Contribution rules
- English. Everything in the repository — docs, comments, commit messages, pull requests — is written in English (ADR-0009). Arabic appears only as data: product labels and UI translations.
- Revenue first. Every recommendation states its expected monthly impact in the configured currency (
packages/i18n/config.ts), a confidence level (low / medium / high), and the revenue channel it affects. - No unverified claims. Compliance, data-residency, and performance statements are marked as open until verified with the authority or provider.
- Frontmatter. Every page carries
titleanddescription. Ordering is controlled bymeta.jsonin each folder. - MDX safety. Placeholders such as
<slug>.example.comand objects such as{ tenantId }go in backticks or code fences.
The ADR process
- Copy
adr/0000-template.mdtoadr/NNNN-verb-object.mdwith the next number. - Fill in context, decision, consequences (including the revenue impact line), rejected alternatives, and references.
- Open it as Proposed. The owner's approval moves it to Accepted.
- A later decision that replaces it sets the old record to Superseded by ADR-NNNN with a short note; records are never deleted.
- Add the new page to
adr/meta.jsonin numeric order.