What
Define and apply a standard cross-reference convention for linking between
documents within a project and across ecosystem projects.
Why
Currently, cross-references between documents are ad-hoc — some use inline links,
some use footnotes, and cross-project references are mostly absent. A consistent
convention enables automated link validation and makes the documentation
interconnected rather than isolated per-project.
How
Intra-Project Cross-Reference Convention
Use blockquote format for outbound references within a project:
> **Cross-reference**:
> [Architecture Guide §3](./ARCHITECTURE.md#section-3) — Thread pool design
> [API Reference](./API_REFERENCE.md) — Public API details
Inter-Project Cross-Reference Convention
Use blockquote format with ecosystem-relative paths:
> **Ecosystem reference**:
> [common_system Result<T>](https://github.com/kcenon/common_system/blob/main/docs/API_REFERENCE.md#result-type) — Error handling base
> [thread_system Thread Pool](https://github.com/kcenon/thread_system/blob/main/docs/ARCHITECTURE.md#thread-pool) — Async execution
Cross-Reference Placement Rules
- Place at the beginning of a section that depends on another document
- Use blockquote (
>) to visually distinguish from regular content
- Include a brief description of why the reference is relevant
- For architecture docs, include a Mermaid dependency diagram:
## Ecosystem Dependencies
```mermaid
graph TD
A[common_system] --> B[thread_system]
A --> C[container_system]
B --> D[logger_system]
B --> E[monitoring_system]
D --> F[database_system]
E --> F
F --> G[network_system]
G --> H[pacs_system]
```
Implementation Steps
- Create
docs/CROSS_REFERENCE_GUIDE.md in common_system as the canonical convention
- Add cross-references to ARCHITECTURE.md in each project (highest-value target)
- Add ecosystem dependency diagrams to each project's README
- Add inter-project references where APIs or patterns are shared
Acceptance Criteria
Related
What
Define and apply a standard cross-reference convention for linking between
documents within a project and across ecosystem projects.
Why
Currently, cross-references between documents are ad-hoc — some use inline links,
some use footnotes, and cross-project references are mostly absent. A consistent
convention enables automated link validation and makes the documentation
interconnected rather than isolated per-project.
How
Intra-Project Cross-Reference Convention
Use blockquote format for outbound references within a project:
Inter-Project Cross-Reference Convention
Use blockquote format with ecosystem-relative paths:
Cross-Reference Placement Rules
>) to visually distinguish from regular contentImplementation Steps
docs/CROSS_REFERENCE_GUIDE.mdin common_system as the canonical conventionAcceptance Criteria
docs/CROSS_REFERENCE_GUIDE.mdexists in common_systemRelated