Skip to content

docs(CLAUDE.md): Fix inaccuracies and expand build/hook documentation#86

Open
squadmonkey wants to merge 1 commit intoluongnv89:mainfrom
squadmonkey:claude/amazing-kare-e6ca53
Open

docs(CLAUDE.md): Fix inaccuracies and expand build/hook documentation#86
squadmonkey wants to merge 1 commit intoluongnv89:mainfrom
squadmonkey:claude/amazing-kare-e6ca53

Conversation

@squadmonkey
Copy link
Copy Markdown

Summary

  • Removes non-existent --max-concurrent flag from build_epub.py examples
  • Corrects Mermaid rendering: uses local mmdc binary, not Kroki.io API
  • Fixes pre-commit hook count and adds full execution order (ruff → bandit → mypy → markdown → validation → epub)
  • Documents --lang, --mmdc-path, --puppeteer-config flags for build_epub.py
  • Documents LINK_CHECK_STRICT=1 env var for strict link validation in CI
  • Adds vi/ and zh/ translation directories to the structure overview
  • Clarifies --lang flag cascades across all validation scripts
  • Adds workflow guidance for when to run pytest vs pre-commit

Test plan

  • Verify build_epub.py --help matches documented flags
  • Confirm pre-commit hook order matches .pre-commit-config.yaml

🤖 Generated with Claude Code

- Remove non-existent --max-concurrent flag from build_epub.py examples
- Correct Mermaid rendering: uses local mmdc binary, not Kroki.io API
- Fix pre-commit hook count (was "four checks" but listed five)
- Add full hook execution order including ruff, bandit, mypy stages
- Document --lang, --mmdc-path, --puppeteer-config flags for build_epub.py
- Add LINK_CHECK_STRICT=1 env var for strict link validation mode
- Document vi/ and zh/ translation directories
- Clarify --lang flag cascades across all validation scripts
- Add workflow guidance for when to run pytest vs pre-commit

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants