fix(scripts): exclude static/ from top-level doc sections - #1810
Open
3822802 wants to merge 1 commit into
Open
Conversation
Collaborator
🟡 Heimdall Review Status
|
3822802
force-pushed
the
fix-exclude-static-dir
branch
from
August 13, 2026 12:43
28651b9 to
82ef974
Compare
3822802
force-pushed
the
fix-exclude-static-dir
branch
from
August 13, 2026 12:46
82ef974 to
6894986
Compare
discoverTopLevelSections() treats every directory under docs/ as a documentation section unless it is in CONSTANTS.skipDirs. docs/static/ holds assets (docs/static/assets/), not docs, so the generated docs/AGENTS.md gets an entry pointing at docs/static/llms.txt, which does not exist. Adds 'static' alongside the other asset directories already skipped (images, videos, logo). Fixes base#1806.
3822802
force-pushed
the
fix-exclude-static-dir
branch
from
August 13, 2026 12:53
006606a to
56016d0
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
docs/AGENTS.mdcurrently links to./static/llms.txt, which does not exist. This fixes the root cause in the generator.Root cause
discoverTopLevelSections()inscripts/lib/docs-utils.jstreats every directory underdocs/as a documentation section unless it is listed inCONSTANTS.skipDirs.docs/static/is not a documentation section — it only containsdocs/static/assets/. Since it was not excluded, the generator emitted a section entry for it, producing a link to allms.txtthat is never generated.Fix
Add
'static'toCONSTANTS.skipDirs, consistent with howimages,videos,logoandopenapiare already excluded.skipDirs: [ 'node_modules', '.git', 'dist', 'build', 'coverage', - '.next', 'images', 'videos', 'logo', 'openapi', '.claude', 'snippets' + '.next', 'images', 'videos', 'logo', 'openapi', '.claude', 'snippets', 'static' ],After this change, regenerating
docs/AGENTS.mdwill no longer emit the- [Static](./static/llms.txt)entry.Verification
docs/static/llms.txt→ 404 (does not exist)docs/static/→ contains onlyassets/docs/AGENTS.mdline 17 →- [Static](./static/llms.txt)Fixes #1806