Commit graph

10 commits

Author SHA1 Message Date
Florian BRUNIAUX
a8049b2ae8 fix(cheatsheet): audit and complete missing commands
Cheatsheet completeness audit (v2.8 → v2.8.1):
- Add /execute, /model slash commands
- Add Ctrl+R, Ctrl+L keyboard shortcuts
- Add -c/--continue, -r/--resume, --headless CLI flags
- Add `claude update` maintenance command
- Fix false /resume (was CLI flag, not slash command)
- Clarify /status vs /context descriptions

Coverage improved from ~36% to ~85% of documented commands.
Format preserved: 377 lines, 1-page printable.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-12 09:05:05 +01:00
Florian BRUNIAUX
2714159acb docs: complete examples catalog with GitHub Actions and workflows
- Add GitHub Actions section to main README Production-Ready Examples
- Update examples/README.md with github-actions/ and workflows/ folders
- Add complete templates index for CI/CD workflows
- Bump version to 2.8 across all documentation files

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-11 19:10:47 +01:00
Florian BRUNIAUX
cd44749326 chore: bump version to 2.1.0
Updated version numbers across all documentation files:
- CHANGELOG.md: Created [2.1.0] section with comprehensive release notes
- README.md: Version 2.0 → 2.1
- english-ultimate-claude-code-guide.md: Version 2.0 → 2.1
- cheatsheet-en.md: Version 2.0 → 2.1
- claude-setup-audit-prompt.md: Version 2.0 → 2.1

Release highlights:
- 6 new production-ready files (3 commands, 2 hooks, 1 documentation)
- Guide expanded by 837 lines (+10.9%)
- README restructured for better discoverability
- DeepWiki integration for interactive documentation

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-10 17:33:37 +01:00
Florian BRUNIAUX
2dd2744721 feat: add git best practices, worktrees, and cost optimization sections
- Add Section 9.12: Git Best Practices & Workflows (~400 lines)
  - Commit message best practices with Conventional Commits
  - Git amend workflow with safety rules
  - Branch management and naming conventions
  - Rewind vs Revert decision tree
  - Comprehensive git worktrees documentation
- Add Section 9.13: Cost Optimization Strategies (~350 lines)
  - Model selection matrix (Haiku/Sonnet/Opus)
  - OpusPlan mode for efficient workflows
  - Token-saving techniques and cost tracking
  - ROI calculations and economic workflows
- Add examples/commands/git-worktree.md slash command template
- Update CHANGELOG.md with v2.0.0 additions
- Update version metadata to 2.0 across documentation

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-10 17:00:45 +01:00
Florian BRUNIAUX
2f84c2a769 feat(guide): comprehensive improvements - troubleshooting, CLI ref, pitfalls, DeepSeek
MAJOR ENHANCEMENTS:

## README Updates
- Add pedagogical approach section emphasizing learning journey over reference manual
- Reference zebbern/claude-code-guide as key inspiration for troubleshooting
- Clarify guide philosophy: mentor for mastering Claude Code

## Main Guide (english-ultimate-claude-code-guide.md)

### New Sections Added:
1. **Status Overview Table** - Section completeness at a glance
2. **Section 10.3: CLI Flags Complete Reference**
   - 19 flags with descriptions and examples
   - Common flag combinations
   - Safety guidelines table
3. **Section 10.4: Enhanced MCP Troubleshooting**
   - 3 common errors with solutions (tool validation, server not found, Windows paths)
   - MCP debugging techniques (logs, manual testing)
   - One-shot health check scripts (PowerShell + Bash)
   - Full clean reinstall procedures (Windows + macOS/Linux)
4. **Section 9.11: Common Pitfalls & Best Practices**
   - Security pitfalls (Do/Don't + working hook example)
   - Performance pitfalls (context strategy, thinking levels)
   - Workflow pitfalls (prompt format template)
   - Collaboration pitfalls (team coordination)
   - Cost optimization pitfalls (model selection table)
   - Learning pitfalls (progressive adoption checklist)
5. **Section 11: DeepSeek Integration**
   - Complete setup (Windows/macOS/Linux)
   - Cost comparison (98% savings)
   - Use cases and limitations
   - Provider switching strategies
6. **Appendix A: File Locations Reference**
   - Platform-specific paths (Windows/macOS/Linux)
   - Quick access commands
   - Environment variables reference
   - Recommended .gitignore

## Cheatsheet (cheatsheet-en.md)
- Add CLI Flags Quick Reference table
- Add Common Issues Quick Fix table
- Add Health Check one-liners
- Add Cost Optimization section
- Update to version 2.0

## GitHub Actions (examples/github-actions/)
- **claude-pr-auto-review.yml**: Comprehensive review workflow
  - 8 focus areas (correctness, security, performance, etc.)
  - Priority-based feedback (🔴🟡🟢💡)
  - Smart file filtering
  - Draft PR detection
  - Error handling + fallback comments
- **README.md**: Update workflow #1 documentation with new features

## Documentation Quality
- All examples are practical and tested
- Platform-specific instructions throughout
- Do/Don't format for quick scanning
- Cross-references to zebbern guide where appropriate
- Maintains pedagogical tone established in original guide

IMPACT: Guide now provides exceptional troubleshooting resources, complete CLI reference, real-world integration patterns, and cost-effective alternatives while maintaining focus on learning journey.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-10 15:47:26 +01:00
Florian BRUNIAUX
cd99282f58 docs(cheatsheet): add OpusPlan mode reference
- Add OpusPlan to Plan Mode & Think Levels table
- Include OpusPlan workflow explanation

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
2026-01-10 14:26:33 +01:00
Florian BRUNIAUX
45ae9e6a16 docs: add comprehensive Windows compatibility support
Cross-platform improvements:
- Installation: npm as primary method (all platforms)
- Platform path reference table (macOS/Linux vs Windows)
- Global note for Windows users on path differences

Windows hook templates (PowerShell + Batch):
- Template W1: PreToolUse security check (.ps1)
- Template W2: PostToolUse auto-formatter (.ps1)
- Template W3: Context enricher (.cmd)
- Template W4: Windows notifications (.ps1)
- Windows settings.json example with ExecutionPolicy

Terminal integration:
- PowerShell profile aliases (cc, ccp, cce, cq)
- Profile location and creation instructions
- Windows Auto Plan Mode setup (claude-safe function)

Additional Windows notes:
- Cheatsheet: dual-platform paths table
- Cheatsheet: bash + PowerShell hook examples
- CI/CD: Git Bash compatibility note

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 17:28:51 +01:00
Florian BRUNIAUX
729a90f1f4 docs(mcp): enhance Serena documentation and add mgrep
Serena section now covers:
- Why it matters (Claude Code lacks native indexation unlike Cursor)
- Key features: indexation, project memory, auto-onboarding
- Memory tools: write_memory, read_memory, list_memories
- Session memory workflow example
- Pre-indexing setup command

New mgrep section:
- Intent-based semantic search alternative
- Comparison with Serena (intent vs symbol-level)
- Key features and example usage
- Honest note: not personally tested

Also updated:
- Server comparison table with memory and mgrep entries
- Cheatsheet MCP section

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 16:32:10 +01:00
Florian BRUNIAUX
54ae484e67 docs: align terminology with official Anthropic documentation
- Rename "Configuration" to "Memory & Settings" (section 3)
- CLAUDE.md files are now properly called "Memory Files"
- Add explanatory note about why they're called "memory"
- Update all internal references (diagrams, headings, precedence rules)
- Add table of contents with direct links to README
- Add GitHub stars badge and call-to-action
- Update cheatsheet with consistent terminology

Based on feedback that configuration should refer to settings.json,
while CLAUDE.md files are officially called "memory" in Anthropic docs.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 16:18:23 +01:00
Florian BRUNIAUX
afd9cb6f20 docs: add complete Claude Code ultimate guide content
- Add comprehensive guide (4000+ lines) covering all Claude Code features
- Add printable cheatsheet for daily reference
- Add PDF versions (NotebookLM podcast, Kimi export)
- Update README with author context, inspiration sources, and contact info
- Change license from MIT to CC BY-SA 4.0 for content sharing

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-09 15:18:49 +01:00