agentjob.ioHandbook

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

SectionWhat you will find
DesignThe glass design system contract that binds tooling/tailwind, packages/ui, and the apps.
ADRsArchitecture 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

  1. 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.
  2. 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.
  3. No unverified claims. Compliance, data-residency, and performance statements are marked as open until verified with the authority or provider.
  4. Frontmatter. Every page carries title and description. Ordering is controlled by meta.json in each folder.
  5. MDX safety. Placeholders such as <slug>.example.com and objects such as { tenantId } go in backticks or code fences.

The ADR process

  1. Copy adr/0000-template.md to adr/NNNN-verb-object.md with the next number.
  2. Fill in context, decision, consequences (including the revenue impact line), rejected alternatives, and references.
  3. Open it as Proposed. The owner's approval moves it to Accepted.
  4. A later decision that replaces it sets the old record to Superseded by ADR-NNNN with a short note; records are never deleted.
  5. Add the new page to adr/meta.json in numeric order.

On this page