Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,16 @@ Eagerly corrected when spotted in **any** file!

Cross-references use the `§` (section sign) prefix. Every reference
carries a **package qualifier** so the target document is never ambiguous.
ADR references (`ADR-T-001`, `ADR-R-001`, …) are an exception — they
use their own `ADR-<PREFIX>-<NNN>` form without the `§` prefix.

| Prefix | Package | Example document |
| ------ | -------------------- | -------------------------------- |
| `T-` | Torrust (root crate) | |
| `M-` | Mudlark | `packages/mudlark/docs/idea.md` |
| `R-` | render-text-as-image | `packages/render-text-as-image/` |
ADR references (`ADR-T-001`, `ADR-S-001`, `ADR-R-001`, …) are an
exception — they use their own `ADR-<PREFIX>-<NNN>` form without the `§`
prefix.

| Prefix | Package | Example document |
| ------ | -------------------- | ---------------------------------------- |
| `T-` | Torrust (root crate) | |
| `M-` | Mudlark | `packages/mudlark/docs/idea.md` |
| `S-` | Sentinel | `packages/sentinel/docs/algorithm.md` |
| `R-` | render-text-as-image | `packages/render-text-as-image/` |

Helper crates (`index-health-check`, `index-auth-keypair`,
`index-config`, `index-config-probe`, `index-cli-common`,
Expand Down
Loading