Add CI to validate docs links and table structure - #4
Merged
Conversation
This repo had no CI configured. Adds a lightweight GitHub Actions workflow that runs a dependency-free Python script on every push/PR to main, checking README.md and docs/*.md for broken relative links, unbalanced brackets/parens, and malformed markdown tables.
vidaunited
marked this pull request as ready for review
July 13, 2026 17:37
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
2 participants
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.
Summary
This repo had no CI configured, so every doc PR had to be spot-checked manually for broken links and malformed tables. Adds:
scripts/check_docs.py— dependency-free Python script that checks README.md and docs/*.md for balanced brackets/parens, broken relative links, and markdown tables with inconsistent column counts across rows.github/workflows/docs-check.yml— runs the script on every push/PR tomainTest plan
Generated by Claude Code