Documentation Overview

Project Context

Docgraph is a specialized linter and graph generator for product documentation managed with standard Markdown. It extracts a directed graph from document blocks and ensures traceability across various design layers—from business actors and use cases down to technical specifications and architecture decisions.

Core Concepts

• Node: A documented unit identified by a unique ID using the <a id="ID_HERE"></a> syntax on its own line.
• Edges: Typed relationships between nodes (e.g., verifies, depends_on, realized_by).
• Graph Validation: Automated checks to ensure all references exist and follow the relationship rules defined in docgraph.toml.

Getting Started

To verify the current documentation graph, run:

docgraph check doc