wiki-sync

Scan and diff project documentation against source code using wiki-sync.yaml.

63|6|Updated Mar 2, 2026
One-click install
npx skills add https://github.com/xiayu519/Tyou --skill wiki-sync-xiayu519
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: wiki-sync
Source: https://github.com/xiayu519/Tyou/tree/main/.agents/skills/wiki-sync
Command: npx skills add https://github.com/xiayu519/Tyou --skill wiki-sync-xiayu519

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

Keeps the project's Wiki/document knowledge base aligned with source code and tooling behavior by scanning and syncing documentation according to repo root configuration (wiki-sync.yaml).

Core Features & Use Cases

  • Config-driven synchronization: scan, diff, and report wiki/docs against source paths and mappings defined in wiki-sync.yaml.
  • Safe write-back: optionally generate a wiki-sync report or a write-enabled todo/output with backups and sensitive data redaction.
  • Coverage audits: identify gaps between source files and wiki/docs, supporting audits of README, Books, AGENTS files, memory, and related documentation.

Quick Start

Run the wiki-sync.ps1 script with the scan command to generate a coverage report and review the results before optionally running report or sync with -Write when you are ready.

Frequently Asked Questions about wiki-sync

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

FAQPage Schema
How do I keep project documentation synchronized with source code changes?

Documentation synchronization aligns project wiki and docs with source code by scanning configured paths and generating diff reports. You run a PowerShell script with the scan command to identify coverage gaps between source files and wiki content, reviewing results before optionally applying write-back updates.

What is a documentation coverage audit and when do I need it?

A documentation coverage audit identifies gaps between source files and wiki content by scanning configured repository paths. You need it when project documentation falls out of sync with source code updates, ensuring README, AGENTS.md, memory, and related docs accurately reflect tool behavior.

Can I preview documentation changes before writing them to my repository?

Yes, you can preview changes by running the scan command to generate a read-only coverage report, or use the report mode to review detailed diffs. This lets you audit exactly what needs updating before executing a write-enabled sync with backups enabled.

Does documentation synchronization work with AGENTS.md and openspec specs?

Yes, the synchronization scans README, Books, skill references, openspec/specs, AGENTS.md, memory, and related documentation. It operates within the repository's wiki/docs scope defined by a YAML configuration file to ensure all mapped documentation content aligns correctly.

How do I safely write documentation updates back to my project files?

Safe write-back synchronization generates outputs with backups of original files and redacts sensitive data before writing. You configure output targets in your YAML configuration file, then execute the sync operation with the write flag enabled to apply changes securely.

What are the limitations of automated wiki and docs synchronization?

Synchronization relies on a YAML configuration file to define repository scopes and mappings, meaning unconfigured documentation paths are ignored. Write operations require explicit execution and only process files within the defined wiki/docs scope to prevent unintended modifications to source code.