marketing-shibata50/claude-code-ultimate-guide
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
22 commits 1 branch 0 tags 20 MiB
Commit graph

12 commits

Author SHA1 Message Date
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
87994bb797 feat(guide): add thinking keywords, GitHub Actions examples, and improvement recommendations 
Documentation enhancements:
- Add inline thinking keywords section (think, think hard, ultrathink) with usage examples
- Create examples/github-actions/ directory with 3 ready-to-use workflows:
  * Auto PR review with inline comments
  * Security review on every PR
  * Issue triage with label suggestions
- Add comprehensive IMPROVEMENT_RECOMMENDATIONS.md with prioritized action items

Improvements based on zebbern/claude-code-guide analysis:
- Enhanced troubleshooting guidance
- Format enhancements (badges, collapsible tables, C-style comments)
- Security/performance/workflow pitfalls sections
- DeepSeek integration documentation
- One-shot health check scripts

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-10 15:26:18 +01:00
Florian BRUNIAUX
266e4d285d docs(guide): add community cybersecurity skills repository section 
Add section 5.5 documenting zebbern/claude-code-guide repository containing 29 cybersecurity-focused skills for penetration testing, security tools, infrastructure security, and application security testing.

Includes:
- Organized skills catalog by domain
- Installation and usage instructions
- Important legal/ethical disclaimers
- Encouragement for community contributions

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-10 14:59:50 +01:00
Florian BRUNIAUX
7d866571fa docs(guide): expand troubleshooting section 
- Add MCP server issues (Serena, Context7, Sequential)
- Add permission pattern examples
- Add timeout troubleshooting
- Add platform-specific installation issues (Windows/macOS/Linux)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-10 14:46:58 +01:00
Florian BRUNIAUX
b2acc9b115 feat: add Learning Paths, examples, and project governance files 
### New Content
- Learning Paths section in README (Junior/Senior/Power User/PM tracks)
- examples/ folder with 18 ready-to-use templates:
  - 4 agents (code-reviewer, test-writer, security-auditor, refactoring)
  - 2 skills (TDD workflow, security checklist)
  - 3 commands (commit, review-pr, generate-tests)
  - 4 hooks (bash + PowerShell for security, formatting)
  - 3 config templates (settings, MCP, gitignore)
  - 2 memory templates (project + personal CLAUDE.md)

### Governance
- CHANGELOG.md: Version history (1.0.0 → 1.1.0 → Unreleased)
- CONTRIBUTING.md: Contribution guidelines for community

### Documentation
- llms.txt: Updated structure with new files/folders

This update makes the guide more actionable with concrete templates
and provides clear learning paths for different skill levels.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
 2026-01-10 14:25:22 +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
28b01c4dfe feat: add audit prompt and enhance guide with advanced patterns 
- Add claude-setup-audit-prompt.md: self-contained prompt for setup analysis
  - 3-phase audit: Discovery → Evaluate & Report → Validation
  - Weighted health score formula (High=3, Med=2, Low=1 points)
  - Stack detection for contextual templates
  - Glossary of terms for beginners
  - Cross-platform paths (Unix + Windows)

- Integrate Nick Tune's workflow patterns:
  - Section 3.1: Single Source of Truth pattern
  - Section 7.1: Shell Scripts vs AI Agents decision framework
  - Section 9.3: Verify Gate pattern with autonomous retry loop
  - Section 9.10: NEW Continuous Improvement Mindset

- Add Community Resources section:
  - 5 awesome-* repos with descriptions
  - SuperClaude framework documentation
  - Learning sites (Claudelog, Official Docs)

- Update README with:
  - Audit tool in What's Inside table
  - Dedicated "Audit Your Setup" section
  - Resources section with community links

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
 2026-01-09 17:18:35 +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
48687e82d3 fix: correct license from MIT to CC BY-SA 4.0 
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
 2026-01-09 15:25:22 +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