Skip to content

Add output validation script and tests for Markdown generation #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

BorisQuanLi
Copy link

This PR introduces a validation script (validate_output.py) and corresponding pytest-based tests to help ensure the structure and content of generated Markdown files in the web-languages-code project.

  • The script checks for required sections (e.g., title, summary) in each Markdown file.
  • A new Makefile target (validate) is included for convenience.
  • Automated tests (test_validate_output.py) are provided for future reliability.

I understand from an email from @wumpus that this repo is rarely run and that the main need is a better knowledge base, potentially in a new repo. This PR is intended as a lightweight, non-intrusive improvement for developer experience and code quality. I am also interested in contributing to higher-priority projects, such as tools for downloading subsets of Common Crawl, if that would be helpful.

Thank you for your

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.

1 participant