skills.rest
dev-goraebap
dev-goraebapCOMMUNITY
Explore all skills by this author →
GitHub

shared-docs

Manage cross-repo documentation via git submodules with init, sync, write, and doctor workflows.

1|Updated Feb 12, 2026
Search Tags:#automation#git#workflow#documentation#multi-repo#submodules#shared-docs
One-click install
npx skills add https://github.com/dev-goraebap/grimoire --skill shared-docs
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: shared-docs
Source: https://github.com/dev-goraebap/grimoire/tree/main/agent-cowork/skills/shared-docs
Command: npx skills add https://github.com/dev-goraebap/grimoire --skill shared-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

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.

Frequently Asked Questions about shared-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I share documentation like PRDs and ADRs across multiple git repositories?▼

You can share documentation across multiple git repositories by centralizing PRDs, ADRs, and domain rules in a dedicated repo and linking it via git submodules. This ensures consistent documentation state across all parent projects.

How do I sync git submodules to fetch the latest shared documentation updates?▼

To sync shared documentation, use the sync workflow to fetch the latest remote updates and update the submodule pointer in the parent repo. This keeps parent repos aligned with the centralized shared-docs repository.

What is the best way to manage cross-repo documentation without duplicating files?▼

Managing cross-repo documentation without duplication is best achieved by storing common files in a shared repository and attaching it as a git submodule. The approach governs edits through a PR/MR workflow to maintain consistency.

Why does my git submodule have a stale pointer or misaligned configuration?▼

A git submodule may have a stale pointer or misaligned configuration due to desynced paths, URLs, or branches. The doctor workflow detects these common pitfalls by validating values read from .gitmodules.

Can I edit shared docs directly in a parent repository and push the changes?▼

Yes, you can use the write workflow to edit shared docs and push changes through a PR/MR workflow. This ensures that documentation changes are properly tracked and propagated across multiple linked repositories.

Related Skills

Explore More Software Engineering Skills→
glhewettglhewett

git-submodule-commit

Commit and push git submodule changes and update the parent repository reference.

Community
Intermediate
roycolumbia-coderoycolumbia-code

gsd-ship

Automates GitHub pull request creation, review triggering, and merge tracking.

Community
Intermediate
BrunoAMSilvaBrunoAMSilva

markdown-to-html

Convert Markdown files to sanitized HTML with templates.

Community
Intermediate
amurataamurata
6

monorepo-management

Configure Turborepo and pnpm workspaces for monorepo architectures.

Community
Advanced