docs: handleiding brak halverwege af op de forge door losse <title> (#2612) #2647

Merged
brenno merged 3 commits from claude/issue-2612-docs-c3eb56 into main 2026-10-28 23:29:48 +00:00
Owner

Closes #2612

Wat er mis was

De link Theming and language in de inhoudsopgave van docs/USER_GUIDE.md deed op de forge niets, en de sectie ontbrak onderaan. De sectie stond wél in het bestand. Forgejo hield alleen eerder op met renderen.

Oorzaak: op regel 5422 stond de plaatshouder <title> los in lopende tekst (*Stijl van <title>*). <title> is in HTML een rauwe-teksttag: alles tot </title> hoort bij die tag. Die sluittag kwam nooit, dus de rest van het document (ruim 1.400 regels, 27 koppen) verdween als titeltekst. docs/ACCESSIBILITY.md had hetzelfde probleem ("Slide 3/12: <title>" op regel 25): alles na de eerste alinea viel weg. De ingebouwde lezer heeft geen HTML-parser en toonde alles wel, dus in de app viel het niet op.

Wat er veranderd is

  • docs: de vier plaatshouders (USER_GUIDE en ACCESSIBILITY, Engels en Nederlands) staan nu tussen backticks. In de NL-versies stond <titel>. Dat slikt niets in, maar Forgejo haalde het woord wel weg.
  • check-conventions: nieuwe regel rawTextTagsIn. Die loopt dezelfde .md-bestanden langs als de scan op conflictmarkeringen, slaat codeblokken en code spans over, en weigert <title>, <script>, <style>, <textarea>, <iframe>, enzovoort buiten code. Vóór de docs-fix wees hij precies de twee bekende plekken aan (USER_GUIDE.md:5422, ACCESSIBILITY.md:25).
  • test: test/markdown_raw_text_tag_test.dart met verzonnen bestanden: lopende tekst, backticks, escape, codeblok, genest hek, en tags die op title lijken.
  • CHANGELOG: regel onder Unreleased, met dank aan Jeroen Hermans voor de melding.

Getoetst

  • Alle docs (docs/*.md en de root-.md's) opgehaald van de forge en het aantal gerenderde koppen vergeleken met de bron. Alleen USER_GUIDE.md (166 → 139) en ACCESSIBILITY.md (4 → 2) liepen achter.
  • De herstelde vier bestanden door Forgejo's eigen /api/v1/markdown/raw gehaald. Alle koppen renderen, het anker theming-and-language bestaat, en de zin rendert als Stijl van <title>.
  • Groen: check_conventions, check-comment-language, translate-docs-check, check-dated-claims, dart analyze en de nieuwe test plus platform_portability_ratchet_test. Een volledige make check heb ik niet gedraaid.

🤖 Generated with Claude Code

Closes #2612 ## Wat er mis was De link *Theming and language* in de inhoudsopgave van `docs/USER_GUIDE.md` deed op de forge niets, en de sectie ontbrak onderaan. De sectie stond wél in het bestand. Forgejo hield alleen eerder op met renderen. Oorzaak: op regel 5422 stond de plaatshouder `<title>` los in lopende tekst (`*Stijl van <title>*`). `<title>` is in HTML een rauwe-teksttag: alles tot `</title>` hoort bij die tag. Die sluittag kwam nooit, dus de rest van het document (ruim 1.400 regels, 27 koppen) verdween als titeltekst. `docs/ACCESSIBILITY.md` had hetzelfde probleem (`"Slide 3/12: <title>"` op regel 25): alles na de eerste alinea viel weg. De ingebouwde lezer heeft geen HTML-parser en toonde alles wel, dus in de app viel het niet op. ## Wat er veranderd is - **docs**: de vier plaatshouders (USER_GUIDE en ACCESSIBILITY, Engels en Nederlands) staan nu tussen backticks. In de NL-versies stond `<titel>`. Dat slikt niets in, maar Forgejo haalde het woord wel weg. - **check-conventions**: nieuwe regel `rawTextTagsIn`. Die loopt dezelfde `.md`-bestanden langs als de scan op conflictmarkeringen, slaat codeblokken en code spans over, en weigert `<title>`, `<script>`, `<style>`, `<textarea>`, `<iframe>`, enzovoort buiten code. Vóór de docs-fix wees hij precies de twee bekende plekken aan (`USER_GUIDE.md:5422`, `ACCESSIBILITY.md:25`). - **test**: `test/markdown_raw_text_tag_test.dart` met verzonnen bestanden: lopende tekst, backticks, escape, codeblok, genest hek, en tags die op `title` lijken. - **CHANGELOG**: regel onder Unreleased, met dank aan Jeroen Hermans voor de melding. ## Getoetst - Alle docs (`docs/*.md` en de root-`.md`'s) opgehaald van de forge en het aantal gerenderde koppen vergeleken met de bron. Alleen USER_GUIDE.md (166 → 139) en ACCESSIBILITY.md (4 → 2) liepen achter. - De herstelde vier bestanden door Forgejo's eigen `/api/v1/markdown/raw` gehaald. Alle koppen renderen, het anker `theming-and-language` bestaat, en de zin rendert als *Stijl van `<title>`*. - Groen: `check_conventions`, `check-comment-language`, `translate-docs-check`, `check-dated-claims`, `dart analyze` en de nieuwe test plus `platform_portability_ratchet_test`. Een volledige `make check` heb ik niet gedraaid. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
Forgejo las een losse `<title>` in lopende tekst als echte HTML-tag en
slikte alles erna in als titeltekst. In USER_GUIDE verdween zo alles
vanaf regel 5422, waaronder "Theming and language" waar de
inhoudsopgave naar wijst; in ACCESSIBILITY alles na de eerste alinea.
De Nederlandse versies hadden `<titel>`: geen inslikker, maar Forgejo
haalde de plaatshouder wel weg.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
`<title>`, `<script>`, `<style>`, `<textarea>` en soortgenoten zijn in
HTML rauwe tekst: een losse openingstag slikt de rest van het document
in. `rawTextTagsIn` loopt alle .md-bestanden langs die ook op
conflictmarkeringen gescand worden, slaat codeblokken en code spans
over, en meldt elke zo'n tag die overblijft. Vóór de docs-fix wees hij
precies de twee bekende plekken aan.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
brenno merged commit 7fa66997ed into main 2026-10-28 23:29:48 +00:00
brenno deleted branch claude/issue-2612-docs-c3eb56 2026-10-28 23:29:49 +00:00
Sign in to join this conversation.
No description provided.