skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
s-hiraoku/synapse-a2a49 installs

synapse-docs

This skill manages all documentation for the Synapse A2A project. It should be used when code changes require documentation updates, when checking documentation consistency, or when manually invoked via /synapse-docs. Triggers automatically when modifying files in synapse/, plugins/, or templates/ directories, and when README.md, guides/, or docs/ need updates.

How do I install this agent skill?

npx skills add https://github.com/s-hiraoku/synapse-a2a --skill synapse-docs
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    This skill is designed to manage and synchronize project documentation with source code changes within the Synapse A2A repository. It uses a human-in-the-loop workflow requiring user approval for all proposed documentation updates and operates strictly within the project's directory structure.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

  • Runlayerpass

    3 files scanned · No issues

What does this agent skill do?

Synapse Docs

This skill ensures Synapse A2A documentation stays synchronized with code changes.

When This Skill Activates

Automatic Triggers

  1. Code changes in core modules - synapse/*.py, synapse/commands/*.py
  2. Profile changes - synapse/profiles/*.yaml
  3. Template changes - synapse/templates/.synapse/*
  4. Plugin/Skill changes - plugins/synapse-a2a/**/*
  5. Configuration changes - pyproject.toml (version, dependencies, entry points)

Manual Invocation

  • /synapse-docs - Run full documentation check and update

Workflow

Phase 1: Detect Changes

When code is modified, identify affected documentation by consulting references/code-doc-mapping.md.

Quick Reference - Common Patterns:

Change TypePrimary DocsSecondary Docs
CLI commandREADME.md, guides/usage.mdguides/references.md, CLAUDE.md
API endpointREADME.md, guides/references.mdguides/enterprise.md
Environment variableREADME.md, guides/settings.mdtemplates/.synapse/settings.json
Profile settingguides/profiles.mdCLAUDE.md
Skill contentplugins/*/SKILL.md.claude/skills/, .agents/skills/(plugins/synapse-a2a/skills/ を編集し sync で配布)

Phase 2: Propose Updates

For each affected document:

  1. Read the current content
  2. Identify the specific section to update
  3. Propose the minimal necessary change
  4. Present changes to user for approval

Update Principles:

  • Maintain existing document style and tone
  • Update only affected sections
  • Keep README.md concise; put details in guides/
  • Ensure consistency across related documents

Phase 3: Synchronize Related Files

After updating primary documents, check for required synchronization:

Skill Synchronization:

plugins/synapse-a2a/skills/ → .claude/skills/
plugins/synapse-a2a/skills/ → .agents/skills/

Template Consistency:

synapse/templates/.synapse/ should match documentation in guides/settings.md

Phase 4: Verify Consistency

Run consistency checks:

  1. CLI commands - Compare README.md ↔ guides/usage.md ↔ guides/references.md
  2. API endpoints - Compare README.md ↔ guides/references.md
  3. Port ranges - Compare README.md ↔ guides/multi-agent-setup.md ↔ CLAUDE.md
  4. Environment variables - Compare README.md ↔ guides/settings.md ↔ templates/settings.json

Document Categories

User-Facing (High Priority)

DocumentPurposeUpdate Frequency
README.mdFirst impression, quick startEvery feature change
guides/usage.mdHow to useCLI/API changes
guides/settings.mdConfiguration referenceSetting changes
guides/troubleshooting.mdProblem solvingNew issues discovered

Developer-Facing

DocumentPurposeUpdate Frequency
CLAUDE.mdDevelopment guide for Claude CodeArchitecture/test changes
guides/architecture.mdInternal designComponent changes
docs/*.mdTechnical specificationsDesign changes

Plugin/Skill

DocumentPurposeUpdate Frequency
plugins/synapse-a2a/README.mdPlugin installationPlugin changes
plugins/*/skills/*/SKILL.mdSkill instructionsFeature changes

Reference Files

For detailed document inventory and code-to-doc mappings, consult:

  • references/doc-inventory.md - Complete list of all documents and their roles
  • references/code-doc-mapping.md - Source file to document relationships

Special Cases

Version Updates

When pyproject.toml version changes:

  1. Update CHANGELOG.md with release notes
  2. Check if README.md test badge needs updating
  3. Update plugins/synapse-a2a/.claude-plugin/plugin.json version if needed

New Feature Addition

For major new features:

  1. Add to README.md feature table
  2. Create or update relevant guide in guides/
  3. Update CLAUDE.md if development workflow affected
  4. Add to guides/README.md navigation if new guide created

Deprecation

When deprecating features:

  1. Mark as deprecated in relevant docs
  2. Add migration guide if needed
  3. Update CHANGELOG.md
  4. Remove from quick start examples in README.md

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/s-hiraoku/synapse-a2a/synapse-docs">View synapse-docs on skillZs</a>