How luongnv89/claude-howto works
Purpose and Entry Points
This is a versioned, multilingual learning repository for Claude Code. Its primary product is Markdown-based tutorials and copyable configuration templates, not a deployed application. Start at README.md, follow the ordered curriculum in LEARNING-ROADMAP.md, or locate installable artifacts through CATALOG.md and INDEX.md.
Curriculum Content Model
Ten numbered modules are the canonical English curriculum, progressing from commands and persistent instructions to automation and extensibility. Core content boundaries are:
• User-invoked command templates: 01-slash-commands/optimize.md, 01-slash-commands/pr.md
• Persistent Claude context examples: 02-memory/project-CLAUDE.md, 02-memory/directory-api-CLAUDE.md
• Auto-invoked skills with instructions, templates, and optional scripts: 03-skills/code-review-specialist/SKILL.md, 03-skills/doc-generator/generate-docs.py
• Specialized delegated-agent definitions: 04-subagents/code-reviewer.md, 04-subagents/secure-reviewer.md
Consumers copy these artifacts into Claude Code’s project or user directories; the repository itself does not execute them as one runtime.
Claude Code Integration Boundaries
The guide models the major Claude Code extension surfaces:
• MCP configurations expose external tools such as GitHub, databases, and filesystem access: 05-mcp/github-mcp.json, 05-mcp/database-mcp.json, 05-mcp/multi-mcp.json.
• Shell/Python hooks provide event-driven validation, formatting, logging, scanning, and notifications: 06-hooks/pre-tool-check.sh, 06-hooks/security-scan.sh, 06-hooks/context-tracker.py.
• Advanced operational modes—planning, background tasks, permissions, and headless CLI—are documented/configured in 09-advanced-features/config-examples.json, 09-advanced-features/planning-mode-examples.md, and 10-cli/README.md.
These are examples and installation inputs for the Claude Code runtime; credentials and services remain external.
Composed Plugin Workflows
Three distributable plugin examples bundle commands, agents, MCP configuration, lifecycle hooks, and operational scripts into higher-level workflows:
• PR review: 07-plugins/pr-review/.claude-plugin/plugin.json, 07-plugins/pr-review/commands/review-pr.md
• DevOps automation: 07-plugins/devops-automation/.claude-plugin/plugin.json, 07-plugins/devops-automation/scripts/deploy.sh, 07-plugins/devops-automation/mcp/kubernetes-config.json
• Documentation generation: 07-plugins/documentation/.claude-plugin/plugin.json, 07-plugins/documentation/agents/api-documenter.md
A typical flow is command/request → project memory and skill selection → isolated subagent delegation → MCP tool access → hooks/scripts for guardrails → synthesized response or external action. Kubernetes, GitHub, databases, filesystem servers, and team notification endpoints are optional external dependencies configured by adopters.
Assessment and Learning Feedback
Repository-local Claude skills implement guided self-assessment and lesson quizzes, producing learning-gap and next-step feedback rather than application state:
• .claude/skills/self-assessment/SKILL.md
• .claude/skills/lesson-quiz/SKILL.md
• .claude/skills/lesson-quiz/references/question-bank.md
Checkpoints are a related Claude Code session capability explained separately in 08-checkpoints/README.md; state is managed by Claude Code, not stored by this repository.
Publishing, Localization, and Quality Pipeline
Python build tooling converts the Markdown corpus into distributable documentation artifacts. scripts/build_website.py renders site pages using scripts/website_templates/page.html.j2; scripts/build_epub.py produces an offline EPUB and can render Mermaid diagrams. Content is translated into parallel language trees including ja/, uk/, vi/, and zh/; synchronization support is in scripts/sync_translations.py.
GitHub Actions provide the automation boundary: .github/workflows/test.yml validates Python tooling, .github/workflows/docs-check.yml checks documentation quality, .github/workflows/pages.yml publishes site output, and .github/workflows/release.yml governs releases. The material local runtime is Python (managed through scripts/pyproject.toml and requirements files), with Node/Tailwind assets only for website styling.
Main entry points: .claude-plugin/plugin.json DevOps plugin · build_website.py Website and EPUB builds · README.md Repository entry · .claude-plugin/plugin.json PR review plugin
Components 19
Curriculum
Canonical learning content and navigation.
- Repository entry
README.md - Learning roadmap
LEARNING-ROADMAP.md - Artifact catalog
CATALOG.md - Core modules · Commands, memory, skills, and delegated-agent examples.
01-slash-commands/optimize.md - Learning assessment · Self-assessment and lesson quizzes produce learning feedback.
.claude/skills/self-assessment/SKILL.md
Claude Code surfaces
Copyable extension examples consumed by Claude Code.
- MCP configurations · Configures optional external tool servers.
05-mcp/multi-mcp.json - Hooks and scripts · Validation, scanning, tracking, and notifications.
06-hooks/pre-tool-check.sh - Advanced modes and CLI · Planning, background work, permissions, and headless CLI.
09-advanced-features/config-examples.json - Checkpoints guide · Claude Code manages checkpoint state.
08-checkpoints/README.md - Claude Code runtime · Adopters install repository artifacts into user or project scope.
- External services · GitHub, databases, filesystem, Kubernetes, and notifications.
Plugin workflows
Composable distributable workflow examples.
- PR review plugin
07-plugins/pr-review/.claude-plugin/plugin.json - DevOps plugin
07-plugins/devops-automation/.claude-plugin/plugin.json - Documentation plugin
07-plugins/documentation/.claude-plugin/plugin.json
Publishing pipeline
Build, localization, and GitHub Actions automation.
- Markdown corpus · Tutorials, templates, and parallel translations.
LEARNING-ROADMAP.md - Translation sync · Synchronizes parallel language trees.
scripts/sync_translations.py - Website and EPUB builds · Renders site pages and offline EPUB artifacts.
scripts/build_website.py - GitHub Actions · Validates tooling and docs, publishes pages, and governs releases.
.github/workflows/pages.yml - Published artifacts · Website and offline EPUB distributions.
Connections 21
- Repository entry → Learning roadmap: guides learners to
- Repository entry → Artifact catalog: links installable artifacts
- Learning roadmap → Core modules: orders
- Core modules → Claude Code runtime: copied into
- Learning assessment → Claude Code runtime: runs as repository-local skills
- MCP configurations → Claude Code runtime: installed for tool access
- Hooks and scripts → Claude Code runtime: installed as lifecycle guardrails
- Advanced modes and CLI → Claude Code runtime: documents operation
- Checkpoints guide → Claude Code runtime: explains session feature
- Claude Code runtime → External services: uses configured tools
- PR review plugin → Claude Code runtime: installs workflow
- DevOps plugin → Claude Code runtime: installs workflow
- Documentation plugin → Claude Code runtime: installs workflow
- PR review plugin → MCP configurations: may bundle tool config
- DevOps plugin → Hooks and scripts: bundles operational scripts
- DevOps plugin → External services: configures Kubernetes access
- Markdown corpus → Translation sync: synchronized across languages
- Translation sync → Website and EPUB builds: supplies localized content
- Markdown corpus → Website and EPUB builds: renders
- Website and EPUB builds → GitHub Actions: validated and executed by
- GitHub Actions → Published artifacts: publishes