Skip to content

ci: catch a missing first documentation chapter in the site check - #36

Merged
ibanFR merged 4 commits into
mainfrom
33-site-content-first-chapter
Sep 30, 2026
Merged

ibanFR merged 4 commits into
mainfrom
33-site-content-first-chapter

Conversation

@ibanFR

@ibanFR ibanFR commented Sep 30, 2026

Copy link
Copy Markdown
Owner

Closes #33

Summary

  • The first chapter's heading is also the software system's name, so the software system page passed the chapter's title check even when the chapter itself was missing.
  • Each chapter now needs a page that has its title and also contains the opening line of its text, taken from the chapter source.
  • The check fails if fewer than four plain words are left in the opening line, so a cut-down line can't match the software system page and reopen the gap. Numbered list lines are skipped, the same as other list lines.

Only .github/scripts/assert-site-content.sh changes.

🤖 Generated with Claude Code

ibanFR and others added 4 commits September 30, 2026 18:53
The first chapter's heading is also the software system's name, so the
software system page satisfied its title check even when the chapter was
missing. Each chapter now needs a page with its title that also carries
the opening line of its text, taken from the chapter source.

Closes #33

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Addresses review of the first-chapter fix: an opening line cut down to a
few words could match the software system page and reopen the gap, so
the check now fails when fewer than four plain words remain. Numbered
list lines are skipped like other list lines.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
The chapter error now also fires when a titled page exists without the
chapter's opening, so it says that instead of reporting no page. The
header documents the four-word minimum on a chapter's opening and how
the opening is taken.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@ibanFR
ibanFR merged commit 85f1c2d into main Sep 30, 2026
3 checks passed
@ibanFR
ibanFR deleted the 33-site-content-first-chapter branch September 30, 2026 20:48
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.

Make the site-content check catch a missing first documentation chapter

1 participant