enhance-docs

Featured

Use when improving documentation structure, accuracy, and RAG readiness.

AI & Automation 989 stars 116 forks Updated yesterday MIT

Install

View on GitHub

Quality Score: 96/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# enhance-docs Analyze documentation for readability, structure, and RAG optimization. ## Parse Arguments ```javascript const args = '$ARGUMENTS'.split(' ').filter(Boolean); const targetPath = args.find(a => !a.startsWith('--')) || '.'; const fix = args.includes('--fix'); const aiMode = args.includes('--ai'); ``` ## Documentation Locations | Type | Location | Purpose | |------|----------|---------| | User docs | `docs/*.md`, `README.md` | Human-readable guides | | Agent docs | `agent-docs/*.md` | AI reference material | | Project memory | `CLAUDE.md`, `AGENTS.md` | AI context/instructions | ## Optimization Modes ### AI-Only Mode (`--ai`) For agent-docs and RAG-optimized documentation: - Aggressive token reduction - Dense information packing - Self-contained sections for retrieval - Optimal chunking boundaries ### Both Mode (`--both`, default) For user-facing documentation: - Balance readability with AI-friendliness - Clear structure for both humans and retrievers ## Workflow 1. **Discover** - Find all .md files 2. **Parse** - Extract structure and content 3. **Check** - Run pattern checks based on mode 4. **Report** - Generate markdown output 5. **Fix** - Apply auto-fixes if --fix ## Detection Patterns ### 1. Link Validation (HIGH) - Broken anchor links (`[text](#missing-anchor)`) - Links to non-existent files - Malformed link syntax ### 2. Structure Validation (HIGH) **Heading hierarchy:** - No jumps (H1 → H3 without H2) - Single H1 per document - Code blocks ...

Details

Author
agent-sh
Repository
agent-sh/agentsys
Created
8 months ago
Last Updated
yesterday
Language
JavaScript
License
MIT

Integrates with

Bundled in these plugins

Similar Skills

Semantically similar based on skill content — not just same category

AI & Automation Featured

enhance-agent-prompts

Use when improving agent prompts, frontmatter, and tool restrictions.

989 Updated yesterday
agent-sh
Data & Documents Listed

docs

Authors, audits, and maintains project documentation across CLAUDE.md / .claude/rules/, AGENTS.md, README.md, and Diátaxis docs/ trees (root + nested for monorepos). Four modes: init scaffolds a tiered docs setup from scratch; update detects drift (dead @imports, renamed commands, stale narrative) and incrementally refreshes via a Placement Resolver that pushes rules to the innermost-ancestor destination; readme writes or audits a README against the standard-readme spec; audit produces a documentation health report across every surface. Routes by kind: hard rules to CLAUDE.md, path-scoped patterns to .claude/rules/, narrative to docs/, marketing to README.md. Triggers on "init claude", "bootstrap docs", "scaffold CLAUDE.md", "update docs", "sync CLAUDE.md", "docs drift", "write a README", "audit our docs", "review the README", "Diátaxis", "/docs".

13 Updated today
mthines
Data & Documents Listed

humanify-docs

Write Markdown docs that read like a person wrote them, or rewrite AI-generated docs so they do — short sections, lists and tables where they help, minimal formatting, no code unless the doc is genuinely technical. For a broad topic (a codebase overview, how a system works end-to-end) it researches with a small, budgeted set of subagents and writes the doc itself. Updating an existing doc keeps its style by default and only adds what was asked. Use when: "humanify this doc", "/humanify-docs", "make this README readable", "write docs for X", "this doc reads like AI, fix it", "document how Y works", "add X to the docs", "update the docs for Y", "write a README for this project", or the user hands over a Markdown file and wants it human-friendly. Every rule here yields to what the user asks for.

1 Updated 2 days ago
Xenoneqq