Cross-Linking Standard
Status: Canonical
Every documentation page must include cross-links so engineers can navigate the graph without search.
Required links
| Page type | Must link to |
|---|---|
| Platform | Contracts index, owning repo, products that consume |
| Product | Modules index, platforms used, deployment |
| Module | Boundaries doc, contracts, events emitted/consumed |
| Agent | Capabilities, persona, benchmark coverage |
| Capability | Intent, tools, permissions, benchmark |
| ADR | Superseded ADRs, affected platforms/products |
| Tutorial | Prerequisites, related tutorials, verification steps |
Link format
markdown
[Display text](./relative/path.md)For external repos:
markdown
[MODULE_BOUNDARIES.md](https://github.com/zaixos/consumer/blob/main/docs/architecture/MODULE_BOUNDARIES.md)Breadcrumb convention
markdown
## Breadcrumbs
[Home](../README.md) → [Platforms](../PLATFORMS/README.md) → PL-003 AI RuntimeRelated pages block
Minimum three links when applicable:
markdown
## Related
- [Parent index](./README.md)
- [Contracts index](../REFERENCE/contracts-index.md)
- [Architecture overview](../ARCHITECTURE/README.md)Registry integration
When a page represents a registerable asset, add:
markdown
**Registry ID:** `PL-003` | `PRD-001` | `capability:crm.appointments`Populate zaixos-registry/docs/indexes/ when asset reaches Canonical status.