skills.rest
arbgjr
arbgjrCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

github-wiki

Sync project documentation and ADRs to a GitHub Wiki.

Updated Jan 17, 2026
Search Tags:#automation#git#documentation#adr#wiki#gh#github-wiki
One-click install
npx skills add https://github.com/arbgjr/satra --skill github-wiki
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: github-wiki
Source: https://github.com/arbgjr/satra/tree/main/.claude/skills/github-wiki
Command: npx skills add https://github.com/arbgjr/satra --skill github-wiki

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires git, gh, python3, and includes scripts (resource) components.

What problem does it solve?

Keeping project documentation aligned across the repository and its GitHub Wiki is error-prone and time-consuming. This Skill automates publishing ADRs, architecture docs, and API references to the wiki, removing manual duplication and drift.

Core Features & Use Cases

  • Automated synchronization of project docs to the GitHub Wiki, including ADRs, architecture documents, and API references.
  • Publish ADRs individually or perform a full wiki sync using the provided scripts.
  • Guide setup and run of GitHub CLI-based operations (gh) to ensure Wiki is initialized and writable.

Quick Start

Run the wiki synchronization to publish all project docs: .claude/skills/github-wiki/scripts/wiki_sync.sh Publish a specific ADR: .claude/skills/github-wiki/scripts/publish_adr.sh .agentic_sdlc/corpus/nodes/decisions/adr-001.yml

Frequently Asked Questions about github-wiki

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

FAQPage Schema
How do I sync project documentation to a GitHub Wiki automatically?▼

To sync project documentation to a GitHub Wiki automatically, you run a shell script that clones the wiki repository, converts local architecture documents, and pushes updates using the gh CLI. This removes manual duplication and keeps the wiki current.

Can I publish a single ADR to GitHub Wiki without syncing everything?▼

Yes, you can publish a single ADR to GitHub Wiki without syncing everything by executing a dedicated script with the specific ADR file path. This allows selective updates of individual architecture decision records.

Do I need the GitHub CLI to publish architecture docs to my repository wiki?▼

Yes, you need the GitHub CLI to publish architecture docs to your repository wiki. The synchronization process relies on the gh CLI to ensure the wiki is initialized and writable before cloning, converting, and pushing documentation updates.

What is the best way to keep API references and ADRs aligned with a GitHub Wiki?▼

The best way to keep API references and ADRs aligned with a GitHub Wiki is to automate synchronization using local tooling. Scripts can batch or selectively update the wiki directly from repository paths, preventing documentation drift.

Why does my GitHub Wiki sync fail when pushing project docs?▼

Your GitHub Wiki sync fails when pushing project docs if the wiki is not initialized or writable. You must use the gh CLI to initialize the wiki first, and ensure dependencies like git, gh, and python3 are properly configured.

Related Skills

Explore More Software Engineering Skills→
L3DigitalNetL3DigitalNet
6

wiki-sync

Synchronizes GitHub wiki content by cloning, diffing, generating, and pushing pages.

Official
Advanced
hmislkhmislk
224

publish-wiki

Publish pending wiki changes from the sibling hmis.wiki repository to GitHub Wiki.

Official
Intermediate
cooperacodecooperacode
5

adr

Generate MADR-based Architecture Decision Records from active wiki pages.

Official
Advanced
marcel-moremarcel-more
17

install-fmide-docs

Clone and install fmIDE GitHub Wiki documentation using git commit hashes.

Community
Intermediate