Commit Graph

50 Commits

Author SHA1 Message Date
Luong NGUYEN 2deba3ac2f docs: sync to Claude Code v2.1.101 with /team-onboarding, /ultraplan, Monitor tool (#73)
* docs: sync to Claude Code v2.1.101 with new feature coverage

Bumps all English docs from v2.1.97 to v2.1.101, adds mandatory Sources
footer block (previously missing), and documents three new features
shipped between v2.1.98 and v2.1.101:

- /team-onboarding (v2.1.101) — new built-in command for generating
  teammate ramp-up guides. Added to 01-slash-commands and CATALOG.
- /ultraplan (v2.1.91+, cloud-env auto-creation in v2.1.101) — full
  section in 09-advanced-features covering launch methods, status
  indicators, and execution options. Replaces prior 3-line stub.
- Monitor tool (v2.1.98) — full section in 09-advanced-features with
  stream-filter and poll-emit patterns and the grep --line-buffered
  warning. Added to resources.md feature table.

Vietnamese and Chinese translations are not touched in this sync.

* fix(docs): address review feedback on v2.1.101 sync

- Correct /team-onboarding availability date (April 10 → April 11, 2026)
- Fix uninitialized \$last variable in Monitor poll-and-emit example
- Update CATALOG.md New Features heading to April 2026 and add Monitor
  Tool, /team-onboarding, and Ultraplan auto-create entries
2026-04-11 22:30:46 +02:00
Luong NGUYEN 63a1416884 fix(docs): correct Claude Code version to 2.1.97 across all footers
The latest Claude Code release is 2.1.97, not 2.3.0 (which is this
guide's own version). Update all 20 "Claude Code Version" footer lines
to accurately reflect the documented Claude Code version.

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
2026-04-09 06:42:51 +02:00
Luong NGUYEN 7f2e77337e docs: update Last Updated date and Claude Code version across all files
Update all documentation footers from generic "April 2026 / 2.1+" to
the specific sync date (April 9, 2026) and documented version (2.3.0).
Also add version/date footers to zh/CATALOG.md and
zh/01-slash-commands/README.md which were missing them.

Generated with [Claude Code](https://claude.ai/code)
via [Happy](https://happy.engineering)

Co-Authored-By: Claude <noreply@anthropic.com>
Co-Authored-By: Happy <yesreply@happy.engineering>
2026-04-09 06:41:16 +02:00
Luong NGUYEN f07313d71f docs: remove contributors section 2026-04-07 11:12:17 +02:00
Luong NGUYEN 4f5537430d docs: update GitHub metrics to 21,800+ stars, 2,585+ forks 2026-04-07 10:40:05 +02:00
Luong NGUYEN 8b42603bb7 chore(release): v2.3.0 2026-04-07 10:27:21 +02:00
Luong NGUYEN 72d3b016e6 docs: sync all tutorials with latest Claude Code docs (April 2026) (#56)
* docs: sync all tutorials with latest Claude Code official docs (April 2026)

Update 44 documentation files to reflect the latest Claude Code features
from code.claude.com. Key content changes include new slash commands
(/ultraplan, /powerup, /sandbox), deprecated command removals (/pr-comments,
/vim), corrected skill description budget (1%/8K), new hook events
(PermissionDenied, InstructionsLoaded, ConfigChange), expanded Agent Teams
section, new plugin components (LSP, bin/, settings.json), and new CLI
flags (--bare, --tmux, --effort, --channels). Added "Last Updated: April
2026" metadata footer to all documentation files.

* fix(docs): correct env var values and alphabetical ordering

- CLAUDE_CODE_NEW_INIT=true → =1 in 02-memory and 09-advanced-features
- CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=true → =1 in 09-advanced-features
- Fix /powerup vs /plugin alphabetical order in slash commands table

* fix(docs): correct env var values in locale files (vi, zh)

Propagate CLAUDE_CODE_NEW_INIT=true → =1 and
CLAUDE_CODE_EXPERIMENTAL_AGENT_TEAMS=true → =1 corrections
to Vietnamese and Chinese translations.
2026-04-07 10:20:53 +02:00
Luong NGUYEN 6cbaa4dd52 docs(readme): add Chinese language link to language switcher 2026-04-06 23:17:18 +02:00
Luong NGUYEN 100c45eef2 docs(readme): add language switcher between English and Vietnamese 2026-04-06 22:19:50 +02:00
Luong NGUYEN 6d1e0ae4af refactor(ci): shift quality checks to pre-commit, CI as 2nd pass (#34)
* refactor(ci): shift quality checks to pre-commit, CI as 2nd pass

- Remove ci.yml (lint, security, pytest were only for EPUB scripts)
- Move EPUB build to pre-commit local hook (runs on .md changes)
- Add check_cross_references.py, check_mermaid.py, check_links.py scripts
- Add markdown-lint, cross-references, mermaid-syntax, link-check as
  pre-commit hooks — mirrors all 4 CI doc-check jobs locally
- Remove spell check job from docs-check.yml (breaks on translations)
- Refactor docs-check.yml to reuse scripts/ instead of inline Python
- Add .markdownlint.json config shared by pre-commit and CI
- Update CONTRIBUTING.md with required dependencies and hook table

* fix(ci): resolve all CI check failures in docs-check workflow

- fix(check_cross_references): skip code blocks and inline code spans
  to avoid false positives from documentation examples; fix emoji
  heading anchor generation (rstrip not strip); add blog-posts,
  openspec, prompts, .agents to IGNORE_DIRS; ignore README.backup.md
- fix(check_links): strip trailing Markdown punctuation from captured
  URLs; add wikipedia, api.github.com to SKIP_DOMAINS; add placeholder
  URL patterns to SKIP_URL_PATTERNS; add .agents/.claude to IGNORE_DIRS
- fix(check_mermaid): add --no-sandbox puppeteer config support via
  MERMAID_PUPPETEER_NO_SANDBOX env var for GitHub Actions Linux runners
- fix(docs-check.yml): pass MERMAID_PUPPETEER_NO_SANDBOX=true to mermaid job
- fix(content): repair broken anchors in README.md, 09-advanced-features;
  fix #plugins -> #claude-code-plugins in claude_concepts_guide.md;
  remove non-existent ./docs/performance.md placeholder links; fix
  dependabot alerts URL in SECURITY_REPORTING.md; update auto-mode URL
  in resources.md; use placeholder pattern for 07-plugins example URL
- remove README.backup.md (stale file)

* fix(check-scripts): fix strip_code_blocks regex and URL fragment handling

- fix regex in strip_code_blocks to avoid conflicting MULTILINE+DOTALL
  flags that could fail to strip indented code fences; use DOTALL only
- strip URL fragments (#section) before dispatching link checks to avoid
  false-positive 404s on valid URLs with anchor fragments

* fix(check-scripts): fix anchor stripping, cross-ref enforcement, and mermaid temp file cleanup

- heading_to_anchor: use .strip("-") instead of .rstrip("-") to also strip leading hyphens
  produced by emoji-prefixed headings, preventing false-positive anchor errors
- check_cross_references: always exit with main()'s return code — filesystem checks
  should block pre-commit unconditionally, not silently pass on errors
- check_mermaid: wrap file-processing loop in try/finally so the puppeteer config
  temp file is cleaned up even if an unexpected exception (e.g. UnicodeDecodeError) occurs
- docs-check.yml: remove now-unused CROSS_REF_STRICT env var

* fix(scripts): fix anchor stripping and mermaid output path

- Replace .strip('-') with .rstrip('-') in heading_to_anchor() so leading
  hyphens from emoji-prefixed headings are preserved, matching GitHub's
  anchor generation behaviour.
- Use Path.with_suffix('.svg') in check_mermaid.py instead of
  str.replace('.mmd', '.svg') to avoid replacing all occurrences of .mmd
  in the full temp path.
2026-04-02 02:20:45 +02:00
Luong NGUYEN 0ca8c37c81 docs(readme): add GitHub #1 Trending badge 2026-04-01 07:39:49 +02:00
Luong NGUYEN 5001525595 docs: Update README stats to reflect current GitHub metrics (5,900+ stars, 690+ forks) 2026-03-29 21:40:44 +02:00
Luong NGUYEN 9cb92d6fff docs: Update README stats to reflect current GitHub metrics (3,900+ stars, 460+ forks) 2026-03-28 16:40:14 +01:00
Luong NGUYEN 167a53acbc chore(release): v2.2.0 2026-03-26 15:04:49 +01:00
Luong NGUYEN 93f9d51513 fix(ci): Add missing cSpell words and README sections for CI compliance
- Add 31 technical terms to cSpell dictionary (ultrathink, agentic, pyright, etc.)
- Add Table of Contents section to README.md
- Add Contributing section to README.md
2026-03-26 14:57:37 +01:00
Luong NGUYEN f78c094740 docs: Sync all tutorials and references with Claude Code v2.1.84
- Slash commands: update to 55+ built-in, add 5 bundled skills, mark 3 deprecated
- Memory: add managed drop-ins (v2.1.83), subagent memory, settings hierarchy
- Skills: add effort, shell frontmatter fields and discovery behavior
- Subagents: add effort, initialPrompt, disallowedTools fields; document Bash agent
- MCP: add WebSocket transport, elicitation, 2KB tool cap, server deduplication
- Hooks: expand from 18 to 25 events, add agent hook type (now 4 types)
- Plugins: add LSP support, userConfig, CLAUDE_PLUGIN_DATA, CLI commands
- Advanced: add Auto Mode, Channels, Voice Dictation, auto permission mode
- CLI: add 17+ new flags, 17 environment variables, new commands
- Update all reference docs (CATALOG, QUICK_REFERENCE, LEARNING-ROADMAP, INDEX)
- Fix stale quiz questions (hook count, permission modes, hook types)
2026-03-26 14:54:29 +01:00
Luong NGUYEN 32a07768b0 docs: Rewrite README as landing-page-structured guide
Restructure README.md using the PAS (Problem-Agitate-Solution) copywriting
framework to better convert visitors into users. Adds badge row, benefit-driven
headline, problem/solution narrative, social proof, FAQ, and multiple CTAs.
All original technical content preserved in collapsible <details> sections.
Original README saved as README.backup.md.
2026-03-18 10:48:16 +01:00
Luong NGUYEN 384a335fda chore(release): v2.1.0 2026-03-13 09:06:56 +01:00
Luong NGUYEN 8fe452029f fix(docs): Update broken URLs, deprecations, and outdated references
- Replace docs.anthropic.com URLs with code.claude.com equivalents across all files
- Mark /review as deprecated with code-review plugin recommendation
- Fix "Sonnet 4.5" → "Sonnet 4.6" model name reference
- Update Task() → Agent() syntax in subagents documentation
- Remove undocumented /todos from slash commands table
- Add verification note about CLAUDE.local.md not in official docs
2026-03-13 04:46:02 +01:00
Luong NGUYEN 8fe0c96f7b docs: Add self-assessment row to guide comparison table 2026-03-04 00:32:16 +01:00
Luong NGUYEN d5b43505eb docs: Add VikalpP to contributors list for PR #7 2026-03-04 00:27:53 +01:00
Luong NGUYEN d5a6106b54 docs: Add self-assessment and lesson-quiz skill references to README and roadmap
Mention /self-assessment and /lesson-quiz skills throughout both files so
learners discover them at every milestone, in progress tracking, and in a
dedicated "Test Your Knowledge" section.
2026-02-26 00:13:00 +01:00
Luong NGUYEN 1ef46cdbac feat: Add adaptive learning path with self-assessment and lesson quiz skills
Redesign LEARNING-ROADMAP.md with a self-assessment quiz that routes users
to Beginner/Intermediate/Advanced paths instead of a single linear track.
Add two project-local skills:

- self-assessment: comprehensive proficiency quiz (quick or deep mode)
  covering 10 feature areas with per-topic scoring and personalized
  learning paths
- lesson-quiz: per-lesson quiz with 100-question bank (10 per lesson)
  for pre-test, progress check, or mastery verification

Update README.md learning path table with "Recommended For" column and
quiz link. Update .gitignore to track project skills.
2026-02-26 00:09:08 +01:00
Luong NGUYEN 487c96d950 docs: Sync all documentation with Claude Code February 2026 features
Update 23 files across all 10 tutorial directories and 7 reference
documents to match the latest Claude Code v2.1+ features and correct
outdated content including model names (4.5→4.6), permission modes,
hook events, CLI syntax, MCP config paths, plugin manifest format,
checkpoint commands, session management, and URLs. Add documentation
for new features: Auto Memory, Remote Control, Web Sessions, Desktop
App, Agent Teams, MCP OAuth, Task List, Sandboxing, and more.
2026-02-25 23:19:08 +01:00
Luong NGUYEN 3cc098505c docs: Add link to skills repository in resources
Add reference to https://github.com/luongnv89/skills in both the main
README and the 03-skills lesson for easy access to ready-to-use skills.
2026-02-04 10:56:05 +01:00
Luong NGUYEN 1807630892 fix: Resolve additional dead links across documentation
- README.md: Fix blog-post link, update claude-examples to anthropic-cookbook
- LEARNING-ROADMAP.md: Update claude-examples to anthropic-cookbook
- claude_concepts_guide.md: Fix 07-hooks to 06-hooks, update skills repo
- 05-mcp/README.md: Fix MCP spec URL
- INDEX.md: Fix all 07-hooks references to 06-hooks
- .github/ISSUE_TEMPLATE/config.yml: Update claude-examples URL
2026-01-15 15:10:02 +01:00
Luong NGUYEN 728fd1eefc docs: Add comprehensive feature catalog with installation commands
Create CATALOG.md containing quick reference for all Claude Code features:
- Slash commands (built-in and custom)
- Sub-agents with capabilities and tools
- Skills with auto-invocation triggers
- Plugins with component breakdowns
- MCP servers for external integrations
- Hooks for event-driven automation

Each feature includes one-command installation instructions.
Update README.md to link to the new catalog.
2026-01-15 14:34:23 +01:00
Luong NGUYEN 58e586f09b refactor: Add new V2.0 logo with dark/light mode support to all markdown files
- Update all main markdown files (INDEX.md, LEARNING-ROADMAP.md, QUICK_REFERENCE.md, CONTRIBUTING.md, claude_concepts_guide.md, resources.md) with new responsive picture element
- Add logo to all subdirectory README files in feature folders (01-10) and plugins
- Replace old markdown image syntax with HTML picture element for dark/light mode adaptation
- Logo automatically displays dark mode version when system prefers dark mode
- Maintain correct relative paths for all nesting levels (../, ../../, etc.)
- Update README.md with new logo syntax

All markdown files now use the new V2.0 starburst logo design with professional dark/light mode support.
2026-01-09 10:36:58 +01:00
Luong NGUYEN 34e2908d1b docs: Update last updated date and clarify model names 2026-01-09 09:28:31 +01:00
Luong NGUYEN 241baf30bd security: Add comprehensive security policy and vulnerability reporting process 2026-01-09 09:25:00 +01:00
Luong NGUYEN 0101d7da84 docs: Add Testing section to README with link to TESTING.md guide 2026-01-09 09:23:35 +01:00
Luong NGUYEN c8d60700b5 docs: Add comprehensive Code of Conduct and update documentation 2026-01-09 09:17:29 +01:00
Luong NGUYEN c1a1c68be5 docs: Add MIT License and update license references in README and CONTRIBUTING 2026-01-09 09:14:05 +01:00
Luong NGUYEN 44233fc7d1 docs: Add comprehensive CONTRIBUTING.md guidelines and update README contributing section 2026-01-09 09:10:24 +01:00
Luong NGUYEN b477228720 docs: Move star history chart to end of README and update table of contents 2026-01-09 09:08:52 +01:00
Luong NGUYEN ae58f0bfc0 docs: Add star history badge to README 2026-01-09 01:23:27 +01:00
Luong NGUYEN 00c734fdbf docs: Move Contributors section to bottom of README 2026-01-09 01:21:49 +01:00
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 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 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 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 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 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 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