mend-docs
Installation
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:
- Skills: Look for all
SKILL.mdfiles in.claude/skills/(recursive). - Agents: Look for agent definitions or metadata in
.claude/agents/. - CRITICAL: Do NOT scan
skills/oragents/directories at the root level. ONLY scan under.claude/.
- 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
<!-- AVAILABLE_SKILLS_START -->and<!-- AVAILABLE_SKILLS_END -->. - CONTRIBUTING.md:
<!-- PROJECT_SKILLS_START -->and<!-- PROJECT_SKILLS_END --><!-- PROJECT_AGENTS_START -->and<!-- PROJECT_AGENTS_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.
- Skills go into
README.mdandCONTRIBUTING.md. - Agents 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.
- 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 |
Related skills
More from nayuta/agent-skills
security-scan
|
20security-review
|
13validate-fix
Iteratively run Agent Skill validation and resolve any issues found.
12mend-agent-rules
Synchronize CLAUDE.md and AGENTS.md with available agents and skills.
12audit-docs
Validate CLAUDE.md and AGENTS.md against actual codebase structure and conventions.
11skill-audit
|
10