> ## Documentation Index
> Fetch the complete documentation index at: https://internal.softcrum.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Internal Documentation — Softcrum Suite

> Private Mintlify project and the engineering source of truth. The same markdown files serve both: agents read them from the repository, humans read them rendered. One source, no sync.

Repository documentation is written in **English** (DEC-I1). Two document sets originate in
Spanish — the legal package and the design registry — and each set is mirrored into the other
language, so every page exists in both. English is authoritative for engineering documents;
Spanish is authoritative for the legal package.

* Milestone **G1-Engage: 2026-11-01** — design partner running CRM + Loyalty end to end.
* External deadline **2026-12-01** — Ley 21.719 fully in force. The legal package must be
  lawyer-reviewed and the breach runbook operational before commercial launch.
* Constitution: [`../../AGENTS.md`](https://github.com/softcrumlabs/softcrum-suite/blob/master/AGENTS.md).

## Map

| Folder                                    | What lives there                                                                                                                        | Status                                   |
| ----------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- |
| [`design/`](/en/design/overview)          | Design source of truth, written in Spanish: the closed decision registry (`DEC-*`), the generation plan and the open-question registers | v1 closed · 70 questions open            |
| [`constitution/`](/constitution/overview) | The reconstructed founding constitution and its amendments                                                                              | Reconstruction + A1 **await validation** |
| [`standards/`](/standards/overview)       | MUST/NEVER rules with anti-examples: data, events, jobs, api, notifications, security, dependencies                                     | Ready for review                         |
| [`adr/`](/adr/overview)                   | Architecture Decision Records, single cross-cutting series                                                                              | 22 ADRs · 001–008 are reconstructions    |
| [`modules/`](/modules/overview)           | Per-module PRD, technical spec and feature specs — the unit of delivery                                                                 | 5 modules · 51 feature specs             |
| [`slices/`](/slices/overview)             | Canonical implementation archetypes agents copy                                                                                         | `trackEvent` is SPEC                     |
| [`runbooks/`](/runbooks/overview)         | Step-by-step operational procedures                                                                                                     | Breach 72 h is launch-blocking           |
| [`task-specs/`](/task-specs/overview)     | Executable work units, TS-001 → TS-005                                                                                                  | Not started                              |
| [`diagrams/`](/diagrams/overview)         | 13 diagram specs + rendered sources and exports                                                                                         | Specs ready, not rendered                |
| [`legal/`](/legal/overview)               | ⚠️ Unreviewed Spanish legal drafts                                                                                                      | **Do not sign, publish or send**         |
| [`glossary.md`](/glossary)                | Canonical vocabulary and forbidden synonyms                                                                                             | Ready                                    |

## How the pieces relate

```
design/decision-registry-v1.md   ──►  the DEC-* every other document cites
        │
        ├─► constitution/         amendments to the closed rules and port list
        ├─► standards/            how to build anything, with anti-examples
        │        └─► adr/         why a specific decision was taken
        │                 └─► modules/    what each module actually contains
        │                          └─► slices/      the pattern to copy
        │                                   └─► task-specs/   the work to execute
        ├─► runbooks/             what to do when it breaks
        ├─► legal/                what we owe data subjects and the regulator
        └─► ../public/            what the customer reads
```

## Order of work

1. Validate [`constitution/founding-constitution.md`](/constitution/founding-constitution) — the
   only thing blocking TS-002, and Part 2 is the part that matters.
2. Review [`constitution/amendment-A1-ports-and-standards.md`](/constitution/amendment-A1-ports-and-standards)
   line by line, then apply it to the root constitution.
3. Answer group A of [`design/open-questions-v2.md`](/en/design/open-questions-v2) — 52 decisions
   that move 37 specs toward `approved`.
4. Sign off the 15 loyalty documents sitting at `review`, and mark the ADRs **Accepted**.
5. Render the 13 diagrams with the `diagram-design` skill into `diagrams/exports/`.
6. Execute TS-001 → TS-005.
7. Send `legal/` to the lawyer; version the feedback in Comply.
8. Publish `../public/` per module as each spec lands.

## The founding gap

The founding session that produced the original constitution is **not in this repository**. Rather
than block on it, the missing documents were rebuilt as *tagged reconstructions*: every claim marked
`[derived]`, `[inferred]` or `[proposed]` so the review can be fast where it is safe and slow where
it is not. None of them is binding until validated.

| Missing original                                              | Where it stands                                                                                                                                          |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Root constitution: rules R1–R20 and the six port categories   | Reconstructed in [`constitution/founding-constitution.md`](/constitution/founding-constitution) — **awaiting validation**. Part 2 is entirely inferred.  |
| ADR-001 … ADR-008                                             | Reconstructed in [`adr/`](/adr/overview), status `Proposed (reconstruction)`                                                                             |
| Canonical slice `createInitiative`                            | Reconstructed in [`slices/create-initiative.md`](/slices/create-initiative)                                                                              |
| Standards v1 (the pre-Engage baseline the v2 documents amend) | **Not reconstructed.** The proposal is to declare the v2 documents self-contained and retire the idea of a v1 — see Part 3 of the founding constitution. |
| Existing outbox contract and its six consumers                | Still missing — referenced by [`standards/events.md`](/standards/events) and ADR-013                                                                     |
| Entitlements engine and tenant provisioning                   | Still missing — referenced by ADR-016 and DEC-G2                                                                                                         |

## Open items that do not block

* **P-3** — unit prices per metric (commercial exercise; ADR-016 defines the framework).
* **Spike** — `pg_partman` availability on Supabase (affects how ADR-018 is implemented, not the decision).
* **Spike** — TypeScript 7 compatibility across Next, Biome and drizzle-kit (`standards/dependencies.md` §7).
* **Pre-G1** — request a Resend rate-limit raise (see [`runbooks/deliverability.md`](/runbooks/deliverability)).
* **P-2** — lawyer review of [`legal/`](/legal/overview).
