Skip to content
View as markdown

Doclinks

When writing or editing markdown documentation, use doclinks tool to resolve file references.

Full documentation if needed: cli/doclinks.md

Syntax

Pattern Example
Code file [service/spec.py](https://github.com/dimensionalOS/dimos/blob/main/dimos/protocol/service/spec.py#L29) → resolves path
With symbol Configurable in [service/spec.py](https://github.com/dimensionalOS/dimos/blob/main/dimos/protocol/service/spec.py#L25) → adds #L<line>
Doc link [Configuration](../../usage/configuration.md) → resolves to doc

Usage

doclinks docs/guide.md   # single file
doclinks docs/           # directory
doclinks --dry-run ...   # preview only