Skip to content

Conversation

@chr-tatu
Copy link
Contributor

@chr-tatu chr-tatu commented Jan 8, 2026

This PR is a follow-up on a discussion from #559.

This PR improves the robustness of the README generation scripts:

  • Added validation to check for TOC markers before processing files
  • Updated pre-commit hooks to use && instead of ; to properly fail on errors
  • Prevents writing undefined to README files when TOC markers are missing
  • Throws clear error messages when validation fails

The script will now block commits if README files are missing the required TOC markers (<!-- start_toc --> and <!-- end_toc -->).

@chr-tatu chr-tatu self-assigned this Jan 8, 2026
@chr-tatu chr-tatu force-pushed the chr-tatu/fix-pre-commit branch from 4523e71 to ac2da35 Compare January 8, 2026 08:52
@chr-tatu chr-tatu mentioned this pull request Jan 8, 2026
@chr-tatu chr-tatu marked this pull request as ready for review January 8, 2026 08:54
@chr-tatu chr-tatu merged commit 92e003c into main Jan 8, 2026
3 checks passed
@chr-tatu chr-tatu deleted the chr-tatu/fix-pre-commit branch January 8, 2026 13:59
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.

3 participants