docs: remove stale docs/llms.txt and gitignore generated llms artifacts - #16329
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Removes a stale, no-longer-generated docs/llms.txt file and updates ignore rules so running docs generation doesn’t leave new LLM-related artifacts and generated API markdown as untracked clutter. This aligns the repo with the current llms.txt generation location (repo root) and keeps generated outputs out of source control on master.
Changes:
- Delete stale
docs/llms.txtthat is no longer updated by the generator. - Add
.gitignoreentries for generateddocs/api/*.mdand top-level/llms.txt. - Update
scripts/generateLLMsTXT.jsJSDoc to reference the correct output file location.
Reviewed changes
Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
scripts/generateLLMsTXT.js |
Fixes the JSDoc to reflect that llms.txt is generated at the repo root. |
docs/llms.txt |
Removes an obsolete, stale committed artifact that won’t be regenerated. |
.gitignore |
Ignores generated API markdown and root llms.txt to prevent untracked build artifacts. |
AbdelrahmanHafez
marked this pull request as ready for review
June 10, 2026 13:42
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.
Since 3c5d395 the llms.txt generator writes to the top level instead of
docs/llms.txt, but the olddocs/llms.txtwas committed and never removed, so master now carries a stale copy the script will never update again.Also, running
npm run docs:generateleaves the new top-levelllms.txtand ~100docs/api/*.mdfiles (markdown versions of the API pages for llms.txt and the copy-markdown button) as untracked clutter. Their.htmlsiblings are already gitignored, the.mdflow just never got the same treatment.This PR:
docs/llms.txtdocs/api/*.mdand/llms.txtgenerateLLMsTXT.jsthat still mentioned the old pathgh-pages keeps these ignore rules commented out so the generated files stay trackable there, #16328 adds the two new patterns to that commented block. When merging master into gh-pages, keep gh-pages's commented versions if
.gitignoreconflicts.