Agent skill
mend-docs
Maintain and synchronize documentation files with the actual codebase (agents and skills).
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/data/mend-docs
SKILL.md
Mend Docs
This skill enables the automatic synchronization of documentation files with the available agents and skills in the repository.
Purpose
To ensure that README.md, CONTRIBUTING.md, and other public documentation files accurately list the capabilities of the agent without manual updates.
Instructions
- Discovery: Scan the following directories and categorize them:
- Reusable Skills: Look for all
SKILL.mdfiles inskills/(recursive). - Project Skills: Look for all
SKILL.mdfiles in.claude/skills/(recursive). - Agents: Look for agent definitions or metadata in
agents/and.claude/agents/.
- Reusable Skills: Look for all
- Extraction: For each skill/agent found, extract:
name: From YAML frontmatter or directory name.description: From YAML frontmatter or first paragraph.path: Relative path from the workspace root.
- Target Identification: Identify documentation files and their respective markers:
- README.md: Use
<!-- REUSABLE_SKILLS_START -->and<!-- REUSABLE_SKILLS_END -->. - CONTRIBUTING.md: Use
<!-- PROJECT_SKILLS_START -->and<!-- PROJECT_SKILLS_END -->.
- README.md: Use
- Formatting: Generate a table for each category.
- Recommended format: A table with columns for Name, Description, and Link.
- Synchronization: Replace the content between the specific markers in the target documentation files.
- Reusable skills go into
README.md. - Project skills go into
CONTRIBUTING.md. - CRITICAL:
README.mdMUST be written in English. Translate any non-English metadata (name, description) to English during the extraction/formatting phase forREADME.md.
- Reusable skills go into
- Verification: Ensure that the formatting is correct and all discovered skills are included in the correct file.
Markers
Reusable Skills (README.md)
<!-- REUSABLE_SKILLS_START -->
<!-- REUSABLE_SKILLS_END -->
Project Skills (CONTRIBUTING.md)
<!-- PROJECT_SKILLS_START -->
<!-- PROJECT_SKILLS_END -->
Example Table Format
| Name | Description | Link |
|---|---|---|
| lint-fix | Iteratively run linters, apply auto-fixes, and resolve remaining issues. | .claude/skills/lint-fix/SKILL.md |
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?