Repository navigation
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new gate fails on existing chapters, and the validator misclassifies legitimate prose and fenced Markdown.
4 open issues
What changed in this PR
Expands Chapter 08’s advanced bitwise coverage and introduces structure validation for Book 01, while retaining the C++20 build.
Changes:
- Adds notes on rotations, endianness, scan contracts, overflow, concurrency, and C++26 SIMD.
- Adds a standard-library-only Python validator and GitHub Actions workflow.
| File | Description |
|---|---|
| scripts/check_chapter_structure.py | Validates chapter headings, timelines, placeholders, and fences. |
| 01_low_level/08_bitwise_ops/README.md | Expands bitwise explanations and references. |
| .github/workflows/chapter-structure.yml | Runs Book 01 structure validation in CI. |
Review effort: Balanced
| with: | ||
| python-version: '3.12' | ||
| - name: Validate Book 01 chapter structure | ||
| run: python scripts/check_chapter_structure.py |
There was a problem hiding this comment.
PR and push runs now validate only changed chapter READMEs; the full-book audit remains available through manual dispatch while the legacy chapters are migrated (3c2c92c).
| chapter = CHAPTER.match(path.parent.name) | ||
| if not chapter: | ||
| return [f"{path}: not a numbered chapter directory"] | ||
| headings = [(len(m.group(1)), m.group(2)) for m in HEADING.finditer(body)] |
There was a problem hiding this comment.
Headings and timeline boundaries/entries are now read from text outside fenced code blocks.
| fences = FENCE.findall(body) | ||
| if len(fences) % 2: | ||
| errors.append("unbalanced fenced code blocks") |
There was a problem hiding this comment.
Fence validation now tracks delimiter character and length, and only accepts a matching closing fence with no trailing content.
Co-authored-by: yuchdev <678436+yuchdev@users.noreply.github.com>
Expand bitwise chapter beyond C++20 with senior-level notes on rotations, endianness, bit-fields, zero-count scan contracts, power-of-two overflow, masks, concurrency, and C++26 SIMD. Introduce a stdlib-only Python chapter-structure validator and GitHub Actions workflow for Book 01. Validator checks five required final H2 sections, consecutive numbered H2s, standards timeline C++98/03–26, TODO placeholders, and balanced code fences. Chapter README is the primary documentation change; existing C++20 build remains. CI validation required.