Knowledge Portal · engineering documentation

Skip to content

Cross-Linking Standard

Status: Canonical

Every documentation page must include cross-links so engineers can navigate the graph without search.


Page typeMust link to
PlatformContracts index, owning repo, products that consume
ProductModules index, platforms used, deployment
ModuleBoundaries doc, contracts, events emitted/consumed
AgentCapabilities, persona, benchmark coverage
CapabilityIntent, tools, permissions, benchmark
ADRSuperseded ADRs, affected platforms/products
TutorialPrerequisites, related tutorials, verification steps

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)

markdown
## Breadcrumbs
[Home](../README.md) → [Platforms](../PLATFORMS/README.md) → PL-003 AI Runtime

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.


ZAIXOS Knowledge Portal — public engineering docs at /docs · Staff operations at /admin