Skip to content

docs: fix three stale/inaccurate repo-meta references (llms.txt, ROADMAP, DEAD-FILE-AUDIT) - #562

Merged
yakew7 merged 1 commit into
yakew7:mainfrom
propcgamer20-png:docs/fix-stale-repo-meta
Sep 10, 2026
Merged

docs: fix three stale/inaccurate repo-meta references (llms.txt, ROADMAP, DEAD-FILE-AUDIT)#562
yakew7 merged 1 commit into
yakew7:mainfrom
propcgamer20-png:docs/fix-stale-repo-meta

Conversation

@propcgamer20-png

Copy link
Copy Markdown
Contributor

Three small, independent doc-accuracy fixes.

#556 - llms.txt is missing 7 of 60 explainers

llms.txt (the short index per llmstxt.org, and the file llms-full.txt's own header points crawlers to) is hand-maintained - scripts/build_explainers.py only regenerates llms-full.txt. It had drifted to 53 of 60 published explainers. Added the 7 missing entries (fairness-accuracy-tradeoff, treatment-equality, multiple-comparisons, simpsons-paradox, conditional-demographic-parity, subgroup-fairness, differential-privacy). All 60 slugs from assets/explainers-data.json are now present. (Follow-up worth considering: have build_explainers.py validate llms.txt's slug list so it can't silently drift again.)

#555 - ROADMAP.md's traction table contradicts its own status line

The "Current traction (September 2026)" table said 53 explainers / 28 contributors / 32 forks. The file's own Phase 1 status line two headings below says "60 explainers published", and METRICS.md's badges say 60 / 29 / 33. Updated the row to 46 | 29 | 33 | 8 | 30K+ | 20 | 7 | 60.

#554 - .github/DEAD-FILE-AUDIT.md misattributes explainers-ui.js

It was bundled into a line claiming the file is <script>-referenced from "index.html, profiler.html, and/or the explainer pages". grep: explainers-ui.js is loaded only by index.html; zero of the 60 generated explainer pages load it. Split onto its own line with the accurate note - its renderDetailPage/renderMarkdown path isn't exercised by any real explainer page (which is why the heading-offset drift in the companion issue went unnoticed).

check_em_dash.py, check_broken_links.py, check_generated_files_current.py pass.

Closes #554
Closes #555
Closes #556

…MAP, DEAD-FILE-AUDIT)

yakew7#556: llms.txt (the hand-maintained short index AI crawlers are pointed
at) listed only 53 of the 60 published explainers - build_explainers.py
only regenerates llms-full.txt, never llms.txt. Added the 7 missing
entries: fairness-accuracy-tradeoff, treatment-equality,
multiple-comparisons, simpsons-paradox, conditional-demographic-parity,
subgroup-fairness, differential-privacy.

yakew7#555: ROADMAP.md's "Current traction" table said 53 explainers, 28
contributors, 32 forks - contradicting the file's own Phase 1 status line
two headings down ("60 explainers published") and METRICS.md's badges
(60 / 29 / 33). Updated the row to 60 / 29 / 33.

yakew7#554: .github/DEAD-FILE-AUDIT.md bundled explainers-ui.js into a line
claiming the file is referenced from "index.html, profiler.html, and/or
the explainer pages". grep confirms it is loaded only by index.html;
zero of the 60 generated explainer pages load it. Split it onto its own
line with the accurate note (its renderDetailPage/renderMarkdown path is
not exercised by any real explainer page - which is why yakew7#553's
heading-offset drift went unnoticed).

Closes yakew7#554
Closes yakew7#555
Closes yakew7#556
@vercel

vercel Bot commented Sep 9, 2026

Copy link
Copy Markdown
Contributor

@propcgamer20-png is attempting to deploy a commit to the yashkewlani2020-gmailcom's projects Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions

github-actions Bot commented Sep 9, 2026

Copy link
Copy Markdown

@yakew7 @Shreyash0712 - new PR touching a path you own, please review.

@yakew7
yakew7 merged commit ac889bf into yakew7:main Sep 10, 2026
18 of 19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

2 participants