Merged
Conversation
Add comprehensive design document for integrating ascii-guard linting into pre-commit hooks and CI/CD workflows. Document covers: - ascii-guard tool overview and purpose - Integration points (pre-commit, CI/CD) - Configuration requirements - Document cleanup strategy (17+ files with ASCII art) - Testing approach and validation tests - Implementation plan and rollout sequence Design document location: docs/design/ascii-guard-integration.md Completes task #272.1 for Linear issue AIT-9. Ready for human review (task #272.2).
Simplified design document per feedback: - Removed verbose details about ascii-guard features - Focused on WHY (AI-generated diagrams have alignment errors) - Focused on HOW (5-step rollout sequence) - Cut document from 520 lines to ~60 lines Design document location: docs/design/ascii-guard-integration.md
…ask#272.4) Add ascii-guard linting to catch ASCII art alignment errors: Pre-commit (.pre-commit-config.yaml): - Uncommented ascii-guard hook - Changed entry from 'ascii-guard lint' to 'uv run ascii-guard lint' - Added exclude pattern for .ai-todo/ CI/CD (.github/workflows/ci-cd.yml): - Added 'Lint ASCII art boxes' step to docs-quality job - Runs after markdownlint, before TODO.md linting Dependencies (pyproject.toml): - Updated ascii-guard from >=0.1.0 to >=1.5.0 Related: AIT-9
…272.6) Tests (tests/validation/test_ascii_art_validation.py): - test_ascii_guard_installed: Verify ascii-guard is executable - test_ascii_guard_passes_on_all_docs: Verify docs pass linting Documentation fixes: - Fixed 7 ASCII art boxes in 3 files: - docs/design/GIT_HOOKS_DESIGN.md (4 boxes) - docs/design/BUG_REPORTING_DESIGN.md (1 box) - docs/archive/RELEASE_NUMBERING_MAPPING.md (2 boxes) All validation tests now pass. Related: AIT-9
Add pre-commit hooks section documenting: - How to install pre-commit hooks - ASCII art guidelines using ascii-guard - Manual commands for linting and fixing Completes ascii-guard integration for AIT-9.
All subtasks completed: - Design document created and approved - Pre-commit hook enabled - CI/CD integration added - Validation tests created (passing) - Documentation cleaned (7 boxes fixed) - CONTRIBUTING.md updated Related: AIT-9
Changed from glob patterns to directory path: - Before: uv run ascii-guard lint '**/*.md' '**/*.mdc' - After: uv run ascii-guard lint docs/ Glob patterns with quotes don't expand in CI/CD shell. Using directory path is simpler and works correctly. Related: AIT-9
Add .ascii-guard.toml configuration: - Scan all text files in repository - Exclude .ai-todo/, .venv/, build artifacts - 10MB file size limit Fix CI/CD command: - Changed from glob patterns to directory scan: 'uv run ascii-guard lint .' - Scans entire repo (254 files) according to config - Properly excludes configured directories Verified locally: 254 files checked, 49 boxes found, 0 errors. Related: AIT-9
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes AIT-9
Summary
Integrated ascii-guard linting into pre-commit hooks and CI/CD workflows to automatically validate ASCII art alignment in documentation. Cleaned 17+ existing documentation files.
Changes
uv run ascii-guard lintdocs-qualityjobBug Reports Filed
Discovered 2 bugs in ascii-guard during integration:
Test Plan