shared-docs

What problem does it solve?

Centralize and govern cross-repo documentation (PRD, ADRs, and domain rules) by storing it in a dedicated shared-docs repository and linking it into parent projects via git submodules.

Core Features & Use Cases

• Init: create the shared-docs repo (optional) and connect it as a submodule to the current project.
• Sync: fetch the latest shared docs from the remote and update the submodule pointer in the parent repo.
• Write: edit shared docs and push changes through a PR/MR workflow, ensuring consistent documentation state across repos.
• Doctor: detect common pitfalls like misaligned .gitmodules, stale pointers, or authentication issues.

Quick Start

Create or attach a shared-docs submodule and begin syncing, editing, and diagnosing common issues.