Does it edit my files without permission?

No, the skill identifies required changes and proposes specific updates for your approval before modifying any documentation files.

What triggers the synapse-docs skill?

It triggers automatically when you modify files in the synapse/, plugins/, or templates/ directories, as well as core files like pyproject.toml and existing documentation in guides/ or docs/.

Can I run a check manually?

Yes, you can use the /synapse-docs command to perform a comprehensive documentation consistency audit and update check at any time.

Does it handle versioning?

Yes, it monitors pyproject.toml for version changes and can automatically update your CHANGELOG.md and related version badges.

How does it know which documents to update?

It references a mapping file located at references/code-doc-mapping.md to determine the precise relationship between specific code files and their corresponding documentation sections.

Synapse Documentation Manager

Name: Synapse Documentation Manager
Author: s-hiraoku

bys-hiraoku

学习与文档

Synchronizes Synapse A2A project documentation with code changes automatically to ensure consistent and up-to-date guides.

关于

The synapse-docs skill is a specialized utility designed for the Synapse A2A ecosystem that maintains strict alignment between the codebase and its supporting documentation. It monitors core modules, profiles, and templates, automatically identifying when a code change necessitates an update to the README, usage guides, or technical references. By leveraging a comprehensive code-to-doc mapping system, it streamlines the maintenance of both user-facing and developer-facing materials, ensuring that manual documentation tasks never fall behind rapid development cycles.

主要功能

Automated code-to-doc mapping for precise documentation updates
0 GitHub stars
Monitors version updates in pyproject.toml to automate changelog entries
Synchronizes changes across README, usage guides, and technical specifications
Ensures consistency between template settings and configuration guides
Manual /synapse-docs command for full project consistency audits

使用场景

Updating CLI usage guides automatically when adding new command-line arguments
Ensuring internal developer guides (CLAUDE.md) reflect latest architectural changes
Synchronizing environment variable documentation with changes in template files

关于

主要功能

Automated code-to-doc mapping for precise documentation updates
0 GitHub stars
Monitors version updates in pyproject.toml to automate changelog entries
Synchronizes changes across README, usage guides, and technical specifications
Ensures consistency between template settings and configuration guides
Manual /synapse-docs command for full project consistency audits

使用场景

Updating CLI usage guides automatically when adding new command-line arguments
Ensuring internal developer guides (CLAUDE.md) reflect latest architectural changes
Synchronizing environment variable documentation with changes in template files