21 Commits

Author SHA1 Message Date
Thiên Toán 90e9c30e93 feat(release): build and publish EPUB artifacts per language (#54)
Extend the release workflow to build separate EPUB artifacts for en, vi,
and zh in parallel via a matrix job, then publish all built files under
a single GitHub Release. Using fail-fast: false so a failure in one
language does not block releasing the others.

Also refactor build_epub.py to drive language-specific paths, filenames,
and titles from a mapping, and add zh support (title/subtitle + choice).
2026-04-07 09:14:06 +02:00
Luong NGUYEN 699fb39a46 ci: shift-left quality gates — add mypy to pre-commit, fix CI failures (#53)
* ci: shift-left quality gates — add mypy to pre-commit, fix CI failures

- Add mypy pre-commit hook (mirrors-mypy v1.13.0) so type checks run locally
- Add [tool.mypy] config to scripts/pyproject.toml with overrides for untyped libs (ebooklib, sync_translations)
- Add mypy>=1.8.0 to requirements-dev.txt
- Fix CI test.yml: remove continue-on-error: true from lint/security/type-check jobs (was silently swallowing failures)
- Fix CI bandit -c path: pyproject.toml → scripts/pyproject.toml
- Fix CI mypy command: use --config-file scripts/pyproject.toml
- Fix CI build-epub: add type-check to needs, fix if: success() → !failure() && !cancelled()
- Fix ruff errors in sync_translations.py (RUF013 implicit Optional, SIM102 nested if)
- Fix mypy errors: add list[str] annotations to errors vars in check_cross_references.py and check_links.py

* fix(ci): install mmdc in build-epub job and correct return type annotation

- Add npm install step for @mermaid-js/mermaid-cli before Build EPUB
  to fix CI failure (mmdc not found error)
- Fix check_translation_status() return type from list[dict] to
  tuple[list[dict], list[dict]] to match the actual return value

* fix(ci): pass --no-sandbox to Puppeteer in build-epub CI job

mmdc (Mermaid CLI) uses Puppeteer/Chromium which requires --no-sandbox
in the GitHub Actions sandboxed environment. Add --puppeteer-config flag
to build_epub.py that passes a Puppeteer JSON config file to mmdc via -p,
and use it in the CI workflow to inject the no-sandbox args.
2026-04-07 00:51:44 +02:00
Luong NGUYEN e76bbe40f2 refactor(epub): replace Kroki HTTP dependency with local mmdc rendering (#10) (#52)
* refactor(epub): replace Kroki HTTP dependency with local mmdc rendering (#10)

Remove httpx/tenacity dependencies and Kroki.io API calls from the EPUB
build pipeline. MermaidRenderer now invokes mmdc (mermaid-cli) as a local
subprocess, eliminating intermittent CI failures caused by network
unavailability. CI workflow installs @mermaid-js/mermaid-cli before build.

* fix(epub): add subprocess timeout and fix deduplication log count

- Add 60s timeout to mmdc subprocess.run to prevent hanging builds
  when Chromium/Puppeteer stalls in headless CI environments
- Fix misleading log that printed unique/total as equal counts;
  now logs "N unique diagrams (M total blocks)" explicitly
- Add test_render_all_timeout and strengthen deduplication assertion
2026-04-06 23:44:59 +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 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 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 e8cdd26db0 ci: Trigger docs-check on config file changes
Add .cspell.json and markdown-link-check-config.json to the
docs-check workflow trigger paths so spelling and link check
config changes are properly validated.
2026-01-15 15:06:21 +01:00
Luong NGUYEN 59a87f10c8 fix: Resolve dead links in documentation files
- 02-memory/README.md: Remove broken example links, keep valid ones
- CONTRIBUTING.md: Fix relative path to SECURITY.md
- 07-plugins/README.md: Update MCP spec URL to working domain
- .github/SECURITY_REPORTING.md: Update OWASP link to valid cheatsheet
- .github/ISSUE_TEMPLATE/*: Replace placeholder links with comments
- .github/markdown-link-check-config.json: Add ignore patterns for
  example URLs in code blocks (docs.example.com, template files)
2026-01-15 15:02:44 +01:00
Luong NGUYEN 5c54d753a1 fix: Add 'srcset' to spell check dictionary and fix Bandit config path in CI workflow 2026-01-09 10:39:41 +01:00
Luong NGUYEN c2130fc769 refactor: Move Python configuration and requirements files to scripts/ directory for better organization 2026-01-09 09:55:03 +01:00
Luong NGUYEN 079988c999 fix: Add comprehensive ignore patterns and spell check terms for CI success 2026-01-09 09:49:02 +01:00
Luong NGUYEN e3835151c9 fix: Expand spell check dictionary and link check ignore patterns for CI 2026-01-09 09:44:01 +01:00
Luong NGUYEN 241baf30bd security: Add comprehensive security policy and vulnerability reporting process 2026-01-09 09:25:00 +01:00
Luong NGUYEN 728bd50804 ci: Add comprehensive automated testing workflows and documentation 2026-01-09 09:22:49 +01:00
Luong NGUYEN 62e8dd9042 ci: Add GitHub Actions workflow for documentation checks 2026-01-09 09:16:23 +01:00
Luong NGUYEN 5fd984a089 docs: Add GitHub issue and PR templates 2026-01-09 09:15:12 +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
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