Commit Graph

46 Commits

Author SHA1 Message Date
Luong NGUYEN 43f7b6c5a6 docs: Add table of contents to README 2026-01-09 01:21:01 +01:00
Luong NGUYEN 3964d26703 docs: Add tagline and "Why This Guide?" section to README
Highlight differences from official Anthropic docs:
- Visual tutorials with diagrams vs reference docs
- Production-ready templates vs basic snippets
- Progressive learning path vs feature-organized
- Guided roadmap with time estimates
2026-01-09 01:18:58 +01:00
Luong NGUYEN 49754ae89d refactor: Condense clean-code-reviewer agent from 345 to 67 lines
- Make agent self-contained by embedding rules (no external file reference)
- Remove redundant sections and verbose examples
- Consolidate evaluation categories into concise checklist
- Simplify output format template
2026-01-09 01:02:22 +01:00
Luong NGUYEN fdbc458ede docs: Add clean-code-reviewer subagent and rules reference
- Add clean-code-reviewer.md subagent for Clean Code principle enforcement
- Add clean-code-rules.md with Robert C. Martin's Clean Code guidelines
2026-01-09 00:32:37 +01:00
Luong NGUYEN 821709b143 Update all lessons 2026-01-08 23:51:46 +01:00
Luong NGUYEN e136b581d9 Add slides/ folder to store some good slides 2026-01-05 22:34:21 +01:00
Luong NGUYEN 15c8ce7f33 docs: Add Boris Cherny's Claude Code workflow to resources
Add link to the creator's X thread sharing his systematized workflow
including parallel agents, Plan mode, and verification hooks.
2026-01-03 00:49:43 +01:00
Luong NGUYEN 3aeffb2f19 docs: Remove star history chart (API not ready) 2025-12-30 22:21:40 +01:00
Luong NGUYEN ad5b1c1b04 docs: Add star history chart to README 2025-12-30 22:16:30 +01:00
Luong NGUYEN 31e779c0e5 chore: Remove openspec from tracking and add to gitignore
- Add openspec/ to .gitignore
- Keep local files but exclude from version control
2025-12-26 13:45:15 +01:00
Luong NGUYEN bb2a0fda42 chore: Remove blog-post from tracking and add to gitignore
- Add blog-post/ to .gitignore
- Keep local files but exclude from version control
2025-12-26 11:04:41 +01:00
Luong NGUYEN 0fcac18357 docs: Add blog post and new slash commands for development workflow
- Add blog post: 4 Essential Slash Commands I Use in Every Project
- Add new slash commands: /doc-refactor, /setup-ci-cd, /unit-test-expand
- Update slash-commands README with comprehensive documentation
- Simplify /push-all command structure
- Archive add-blog-post-slash-commands change
- Add blog-post spec and pending openspec changes
2025-12-26 11:02:19 +01:00
Luong NGUYEN 8ef1e4a0c0 docs: Update hooks lesson with improved context tracker example
- Replace simple Stop-only context-usage hook with hook pair pattern
- Add UserPromptSubmit + Stop hook combination for tracking delta
- Include both char-estimation and tiktoken versions as separate files
- Show how to use session_id for isolated state tracking
2025-12-25 18:10:16 +01:00
Luong NGUYEN fa9603af11 chore: Archive add-cli-lesson change 2025-12-25 00:02:55 +01:00
Luong NGUYEN 513171332e fix: correct token calculation in context-usage hook example
The hook was converting total_chars to string before calculating tokens,
resulting in ~0 tokens reported. Fixed to calculate directly from char count.

- Remove unused estimate_tokens() function
- Calculate tokens as total_chars // 4 directly
- Archive fix-context-usage-hook change
2025-12-24 23:54:35 +01:00
Luong NGUYEN ecd3dba49a chore: Archive update-skills-lesson change 2025-12-24 23:52:39 +01:00
Luong NGUYEN e978c4949d docs: Update skills lesson with managing, debugging, and best practices
- Add Managing Skills section (viewing, testing, updating, removing)
- Expand Troubleshooting with debugging tips for skipped skills, YAML errors, permissions
- Add Version History best practice section with example
- Enhance allowed-tools documentation with security use cases
- Add Multi-File Skill Example showing complex skill structure
- Add version history to code-review SKILL.md example

Based on: https://code.claude.com/docs/en/skills
2025-12-24 23:30:50 +01:00
Luong NGUYEN b44d9d6a77 chore: Archive update-subagents-lesson change 2025-12-24 23:28:19 +01:00
Luong NGUYEN 2177035e51 docs: Update subagents lesson based on official documentation
- Update README with all official features:
  - Built-in subagents (General-Purpose, Plan, Explore)
  - /agents command for interactive management
  - CLI-based configuration with --agents flag
  - Resumable agents with agentId
  - File locations and priority order
  - Configuration fields (name, description, tools, model, permissionMode, skills)
  - Chaining subagents for multi-agent workflows

- Update existing subagent examples to new format:
  - Add model field
  - Update YAML frontmatter format
  - Add proactive usage hints in descriptions

- Add new example subagents:
  - debugger.md - Root cause analysis specialist
  - data-scientist.md - SQL/BigQuery data analysis expert

Based on: https://code.claude.com/docs/en/sub-agents
2025-12-24 23:27:19 +01:00
Luong NGUYEN d291519452 chore: Archive add-context-usage-hook-example change 2025-12-24 23:22:58 +01:00
Luong NGUYEN 9c5c7c5049 docs: Add context usage reporter hook example
Add Example 6 showing how to create a hook that reports context/token
usage after each Claude response:

- Python script reads transcript_path to access conversation history
- Estimates tokens using ~4 chars/token heuristic
- Outputs one-line report: "Context: ~45k/200k tokens (77% remaining)"
- Documents both Stop and UserPromptSubmit hook configurations
- Explains limitations (estimate vs exact /context command)
2025-12-24 23:21:38 +01:00
Luong NGUYEN e144e42b20 chore: Archive update-hooks-lesson change
Move completed change to archive and create hooks-documentation spec.
2025-12-24 15:48:15 +01:00
Luong NGUYEN eb72f002ef docs: Add CLI Reference lesson (10-cli)
Add comprehensive CLI reference documentation covering:
- All CLI commands and flags with examples
- Model configuration, system prompts, permissions
- Output formats (text, JSON, stream-JSON)
- Session management and MCP configuration
- 7 high-value use cases: CI/CD, piping, batch processing,
  multi-session workflows, custom agents, security, JSON API

Update README.md and LEARNING-ROADMAP.md with CLI lesson
navigation and learning path integration.
2025-12-24 15:42:24 +01:00
Luong NGUYEN c1ef277925 docs: Rewrite hooks documentation based on official Claude Code docs
- Update configuration format to use array-based matcher/hooks structure
- Document all 9 official hook events (PreToolUse, PermissionRequest,
  PostToolUse, Notification, UserPromptSubmit, Stop, SubagentStop,
  PreCompact, SessionStart, SessionEnd)
- Add JSON stdin input/output documentation with schemas
- Document exit code semantics (0=success, 2=blocking, other=warning)
- Add prompt-based hooks for Stop/SubagentStop events
- Add environment variables (CLAUDE_PROJECT_DIR, CLAUDE_ENV_FILE, etc.)
- Add security considerations with official disclaimer
- Add MCP tool hook patterns (mcp__<server>__<tool>)
- Update example scripts to use JSON stdin parsing
- Add debugging section with claude --debug flag
- Remove incorrect hook types (PreCommit, PostCommit, PrePush)

Based on official documentation: https://code.claude.com/docs/en/hooks
2025-12-24 15:36:49 +01:00
Luong NGUYEN c807674593 chore: Archive update-slash-commands-session change
- Move change to archive/2025-12-24-update-slash-commands-session
- Create specs/slash-commands/spec.md with 10 requirements
2025-12-24 15:32:26 +01:00
Luong NGUYEN ee0f4bd5d9 docs: Update slash commands documentation with official features
- Add comprehensive built-in commands reference (40+ commands)
- Document argument handling ($ARGUMENTS, $1, $2, etc.)
- Add bash execution syntax (! prefix) and file references (@ prefix)
- Update frontmatter to official fields (allowed-tools, argument-hint, model, etc.)
- Add Plugin Commands and MCP Slash Commands sections
- Add SlashCommand Tool documentation for programmatic invocation
- Add Skills vs Slash Commands comparison table
- Create commit.md example with bash execution and context
- Update existing examples to use official frontmatter format
- Add OpenSpec proposal for change tracking
2025-12-24 15:30:47 +01:00
Luong NGUYEN b180c4f8e5 Update slide with correct number 2025-12-15 22:01:53 +01:00
Luong NGUYEN 438501b0af add presentation on Coding with AI 2025-12-15 14:59:37 +01:00
Luong NGUYEN 3a1f45e5e9 fix(ci): Use virtual environments instead of --system flag
The --system flag fails on GitHub Actions runners because Python is
externally managed. Using uv venv + uv pip install instead.
2025-12-10 23:54:08 +01:00
Luong NGUYEN 540508f392 ci: Add DevOps quality assurance with pre-commit hooks and GitHub Actions
- Add pre-commit hooks: Ruff lint/format, Bandit security scan, YAML/TOML validation
- Add GitHub Actions CI workflow: lint, security, test, and build jobs
- Configure Ruff and Bandit in pyproject.toml
- Add pytest test suite for build_epub.py (25 tests)
- Fix code issues: exception chaining, httpx timeout, formatting
- Add requirements.txt and requirements-dev.txt
2025-12-10 23:49:52 +01:00
Luong NGUYEN 8b38c22f64 Merge pull request #1 from wjhrdy/main
add a tool to create an epub
2025-12-10 22:20:53 +01:00
Willy Hardy 7a781da859 chore: Update .gitignore to include blog-posts directory and exclude EPUB files
- Added blog-posts/ to .gitignore to prevent tracking of blog-related files.
- Included rule to ignore all EPUB files in the root directory for cleaner repository management.
2025-12-10 09:19:37 -05:00
Luong NGUYEN a6380d8a30 Update skills documentation to latest Claude Code format
- Migrate SKILL.md files to new format (lowercase names, consolidated descriptions)
  - Remove deprecated fields: version, tags, when_to_use
  - Add Creating Custom Skills section with format requirements
  - Add Troubleshooting Guide and team sharing sections
  - Enhance Best Practices with specific examples
  - Remove Pre-built Skills section (no longer in official docs)
2025-12-10 00:59:48 +01:00
Luong NGUYEN c3ca4390ee Update funding information in FUNDING.yml 2025-12-09 22:33:33 +01:00
Willy Hardy 57ff23f9e0 feat: Add EPUB generation tool and workflow
- Introduced a new script to build an EPUB from markdown files, enhancing documentation accessibility.
- Added a GitHub Actions workflow for automated EPUB builds on version tag pushes.
- Created the initial EPUB file 'claude-howto-guide.epub' for distribution.

This update streamlines the process of creating and releasing the Claude How-To guide in EPUB format.
2025-12-09 12:07:40 -05:00
Willy Hardy a737d687eb add a tool to create an epub. 2025-12-02 11:14:53 -05:00
Luong NGUYEN 27ad9da05e Update memory doc with the update from offical claude code website 2025-11-23 22:30:36 +01:00
Luong NGUYEN cbfc41228f add resources.md - list of interesting resources with detail notes 2025-11-23 00:46:31 +01:00
Luong NGUYEN 5caeff2f1c refactor: Reorganize repository structure for optimal learning path
Reorder folders based on learning dependencies, complexity, and frequency of use:
- 01-slash-commands (unchanged) - Quick wins for beginners
- 02-memory (was 03) - Essential foundation
- 03-skills (was 05) - Auto-invoked capabilities
- 04-subagents (was 02) - Task delegation
- 05-mcp (was 04) - External integration
- 06-hooks (was 07) - Event automation
- 07-plugins (was 06) - Bundled solutions
- 08-checkpoints (unchanged) - Safe experimentation
- 09-advanced-features (unchanged) - Power user tools

Documentation improvements:
- Add LEARNING-ROADMAP.md with detailed milestones and exercises
- Simplify README.md for better scannability
- Consolidate Quick Start and Getting Started sections
- Combine Feature Comparison and Use Case Matrix tables
- Reorder README sections: Learning Path → Quick Reference → Getting Started
- Update all cross-references across module READMEs

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-09 17:54:58 +01:00
Luong NGUYEN 1df7ed4916 docs: Add blog post link and convert logo to PNG format
- Add Medium blog post link about slash commands to README files
- Convert claude-howto-logo.svg to PNG format (1024x256)
- Replace old claude-ai-icon.webp with new logo
- Update .gitignore to exclude blog-posts directory

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 19:12:11 +01:00
Luong NGUYEN 346a2fa993 docs: Add project logo to all README files
- Add claude-howto-logo.svg to 12 README files across the project
- Use appropriate relative paths for different directory levels
- Include new memory guide screenshots
- Add personal CLAUDE.md configuration

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 09:45:26 +01:00
Luong NGUYEN 70af4cd931 docs: Add push-all slash command documentation and screenshot
- Add comprehensive push-all command documentation
- Include PR slash command screenshot
- Update .gitignore configuration
- Update slash commands README

🤖 Generated with Claude Code

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 02:24:10 +01:00
Luong NGUYEN 41527aed26 Update all concept README files with comprehensive documentation
Extract and consolidate information from claude_concepts_guide.md into
individual concept folders:

- 01-slash-commands: Add architecture diagrams, features table, lifecycle
  diagram, best practices, and comprehensive examples
- 02-subagents: Add architecture, configuration, tool access hierarchy,
  context management, and practical delegation examples
- 03-memory: Add memory hierarchy, locations table, lifecycle diagram,
  4 practical examples, and features comparison
- 04-mcp: Add MCP architecture, ecosystem, setup process, 4 examples
  (GitHub, Database, Multi-MCP, Filesystem), and security best practices
- 05-skills: Add skill architecture, loading process, 3 complete examples
  with Python scripts (Code Review, Brand Voice, Documentation Generator)
- 06-plugins: Add plugin architecture, marketplace, lifecycle, 3 examples,
  features comparison, and publishing guide
- 07-hooks: Add hook types table, common examples, variables, 5 practical
  examples with code, and best practices
- 08-checkpoints: Add key concepts, all commands, use cases table,
  configuration, 4 practical examples, and troubleshooting
- 09-advanced-features: Add Planning Mode, Extended Thinking, Background
  Tasks, Permission Modes, Headless Mode, Session Management, interactive
  features, and complete configuration examples

All READMEs now include:
- Overview sections with clear explanations
- Mermaid diagrams for visual understanding
- Comprehensive tables and feature comparisons
- Practical code examples and templates
- Installation instructions
- Best practices and troubleshooting
- Cross-references to related concepts

Total changes: +3706 lines of comprehensive documentation

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 01:51:06 +01:00
Luong NGUYEN d17564a9f2 Add custom SVG logo to Claude How To project
Created a professional SVG logo for the project featuring:
- Modern gradient design with code brackets symbol
- Book/guide icon representing learning and documentation
- "Claude How To" branding with subtitle
- Decorative elements and professional color scheme

Added logo to all major documentation files:
- README.md
- INDEX.md
- QUICK_REFERENCE.md
- claude_concepts_guide.md

The logo provides consistent branding across the project and improves visual appeal on GitHub and other markdown viewers.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 00:41:46 +01:00
Luong NGUYEN 6238744478 Add comprehensive Claude Code advanced features
Added three new major feature categories with complete documentation and examples:

## New Features

### 07-hooks/
- Event-driven automation with 6 example hook scripts
- Pre/post tool hooks, session hooks, and git hooks
- Auto-formatting, security scanning, test automation
- Complete documentation with best practices

### 08-checkpoints/
- Conversation state snapshots and rewind capability
- Safe experimentation and approach comparison
- Real-world examples: DB migration, performance optimization, UI iteration
- Checkpoint management commands and workflows

### 09-advanced-features/
- Planning Mode: detailed implementation plans before coding
- Extended Thinking: deep reasoning for complex problems
- Background Tasks: long-running operations without blocking
- Permission Modes: unrestricted, confirm, read-only, custom
- Headless Mode: CI/CD integration and automation
- Session Management: multiple work sessions
- Interactive Features: keyboard shortcuts, command history
- 10+ configuration examples for different scenarios

## Documentation Updates

- README.md: Added sections for all new features with examples
- INDEX.md: Updated with new categories, file listings, and search keywords
- QUICK_REFERENCE.md: Added quick reference for new features
- claude_concepts_guide.md: Comprehensive guide sections for new concepts

## Statistics

- Total files: 90+ (up from 71)
- Categories: 9 (up from 6)
- New hook scripts: 6
- New documentation files: 10+
- Configuration examples: 10+ scenarios

All examples are production-ready and follow Claude Code best practices.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 00:27:53 +01:00
Luong NGUYEN 7db5ade777 Initial commit: Claude How To project
Added comprehensive examples for Claude Code features including slash commands, subagents, memory, MCP protocol, skills, and plugins with documentation and quick reference guides.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
2025-11-08 00:09:21 +01:00