From 2c2ce2fcaca7a3e46e4798cae811bdb11afc4f93 Mon Sep 17 00:00:00 2001 From: Vinta Chen Date: Sun, 16 Aug 2026 15:57:36 +0800 Subject: [PATCH] docs: document empirically verified README parsing behavior Capture parser quirks worth knowing before editing README.md: everything above is ignored, new subcategories need no parser change, a standalone all-bold paragraph becomes a Thematic Group marker, prose after leaks into llms.txt, and the build's "Total entries" figure counts sub-items rather than just entries. Co-Authored-By: Claude --- website/readme_parser.py | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/website/readme_parser.py b/website/readme_parser.py index 61bf1e98..84887d0f 100644 --- a/website/readme_parser.py +++ b/website/readme_parser.py @@ -1,4 +1,13 @@ -"""Parse README.md into structured section data using markdown-it-py AST.""" +"""Parse README.md into structured section data using markdown-it-py AST. + +Empirically verified behavior worth knowing before editing README.md: +everything above `## Projects` is ignored; new subcategories need no +parser change (a bullet without a leading link plus indented entries); +a standalone all-bold paragraph inside the Projects region becomes a +Thematic Group marker; prose placed right after `## Categories` leaks +into llms.txt; the build's "Total entries" figure counts sub-items +(indented links under an entry), not just entries. +""" from __future__ import annotations