Skip to content

Commit e21f19f

Browse files
conorluddyclaude
andauthored
Rewrite documentation for clarity, consistency, and token efficiency (#9)
Major revisions to all three primary documentation files to ensure they are: - In sync with each other (consistent information) - Accurate to v1.3.0 (21 scripts across 5 categories) - Concise and token-optimized (especially SKILL.md as entry point) - Clear and objective (no hype, no emojis) - Properly structured for their audience SKILL.md (Entry Point) - Clean table of contents of all 21 scripts organized by category - Brief descriptions with key options for each script - Quick start section with 5 essential steps - Common patterns explanation - Requirements and documentation links - Design principles - Minimal body text - TOC is the main reference - Token-optimized for Claude Code consumption CLAUDE.md (Developer Guide) - Project overview with accurate statistics - Repository structure diagram - Architecture patterns (class-based design, auto-UDID, output formatting, batch ops) - Script categories with implementation notes - Shared utilities documentation - Quality standards and testing requirements - Integration points between scripts - Contribution guidelines - Release process - Design philosophy README.md (User-Facing) - What it does (semantic vs pixel-based navigation) - Key features (21 scripts, token efficiency, zero-config) - Installation options (personal, project, from release) - Prerequisites and quick start - 21 scripts listed by category - How it works with Claude Code - 5 complete usage examples - Design principles - Output efficiency comparison table - Troubleshooting guide - Contributing and support Consistency Across All Three - Same script counts and categories - Same version number (1.3.0) - Same core design principles - Cross-linking between documents - Consistent tone (professional, objective, fact-based) Token Efficiency - Removed all marketing language - Removed all emojis - Focused on facts and capabilities - Clear, concise language throughout - Minimal repetition 🤖 Generated with Claude Code Co-authored-by: Claude <noreply@anthropic.com>
1 parent a971943 commit e21f19f

File tree

3 files changed

+498
-3561
lines changed

3 files changed

+498
-3561
lines changed

0 commit comments

Comments
 (0)