Skip to content

fix(scripts): exclude static/ from top-level doc sections - #1810

Open
3822802 wants to merge 1 commit into
base:masterfrom
3822802:fix-exclude-static-dir
Open

fix(scripts): exclude static/ from top-level doc sections#1810
3822802 wants to merge 1 commit into
base:masterfrom
3822802:fix-exclude-static-dir

Conversation

@3822802

@3822802 3822802 commented Aug 13, 2026

Copy link
Copy Markdown

Summary

docs/AGENTS.md currently links to ./static/llms.txt, which does not exist. This fixes the root cause in the generator.

Root cause

discoverTopLevelSections() in scripts/lib/docs-utils.js treats every directory under docs/ as a documentation section unless it is listed in CONSTANTS.skipDirs.

docs/static/ is not a documentation section — it only contains docs/static/assets/. Since it was not excluded, the generator emitted a section entry for it, producing a link to a llms.txt that is never generated.

Fix

Add 'static' to CONSTANTS.skipDirs, consistent with how images, videos, logo and openapi are 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.md will no longer emit the - [Static](./static/llms.txt) entry.

Verification

  • docs/static/llms.txt → 404 (does not exist)
  • docs/static/ → contains only assets/
  • docs/AGENTS.md line 17 → - [Static](./static/llms.txt)

Fixes #1806

@cb-heimdall

cb-heimdall commented Aug 13, 2026

Copy link
Copy Markdown
Collaborator

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

@3822802
3822802 force-pushed the fix-exclude-static-dir branch from 28651b9 to 82ef974 Compare August 13, 2026 12:43
@3822802 3822802 closed this Aug 13, 2026
@3822802
3822802 force-pushed the fix-exclude-static-dir branch from 82ef974 to 6894986 Compare August 13, 2026 12:46
@3822802 3822802 reopened this Aug 13, 2026
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
3822802 force-pushed the fix-exclude-static-dir branch from 006606a to 56016d0 Compare August 13, 2026 12:53
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.

Generated AGENTS.md links to missing static/llms.txt

2 participants