Skip to content

docs: add llms.txt - #16312

Merged
vkarpov15 merged 15 commits into
masterfrom
vkarpov15/gh-15687
Jun 9, 2026
Merged

docs: add llms.txt#16312
vkarpov15 merged 15 commits into
masterfrom
vkarpov15/gh-15687

Conversation

@vkarpov15

Copy link
Copy Markdown
Collaborator

Summary

Add a script to generate an llms.txt in line with MongoDB's and Vue's

Examples

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds generation and checked-in output for a Mongoose llms.txt documentation index, integrating it into the existing docs generation flow.

Changes:

  • Adds scripts/generateLLMsTXT.js to build docs/llms.txt from the docs file map.
  • Wires llms.txt generation into scripts/website.js.
  • Updates tutorial/TypeScript title prefixes and syncs one tutorial snippet with its acquit source.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 12 comments.

Show a summary per file
File Description
scripts/generateLLMsTXT.js New generator for grouped llms.txt documentation links.
scripts/website.js Calls and exports the llms.txt generator during docs rendering.
docs/llms.txt Generated llms.txt documentation index.
docs/source/tutorials.js Changes tutorial title prefix used by mapped subdocs.
docs/source/typescript.js Changes TypeScript title prefix used by mapped subdocs.
docs/tutorials/findoneandupdate.md Removes comments from an acquit-backed example block.

Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread docs/source/tutorials.js
Comment thread docs/source/typescript.js
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread docs/source/tutorials.js
Comment thread docs/source/typescript.js
Comment thread scripts/generateLLMsTXT.js Outdated

@hasezoey hasezoey left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mostly looks good to me, though some style nitpicks.

Note that i minimized duplicate Copilot comments. (because for some reason there were 3 comments each time)

Comment thread docs/llms.txt
Comment thread docs/source/tutorials.js
Comment thread scripts/generateLLMsTXT.js
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread scripts/generateLLMsTXT.js Outdated
Comment thread scripts/generateLLMsTXT.js
@hasezoey hasezoey added the docs This issue is due to a mistake or omission in the mongoosejs.com documentation label Jun 1, 2026
@vkarpov15
vkarpov15 requested a review from hasezoey June 3, 2026 17:59
Comment thread scripts/website.js Outdated
Comment thread docs/source/api.js

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@AbdelrahmanHafez
AbdelrahmanHafez requested a review from Copilot June 5, 2026 07:01

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Comment thread scripts/website.js
Comment thread scripts/website.js Outdated
Comment thread scripts/website.js Outdated
Comment thread scripts/website.js
Comment thread scripts/website.js

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As Copilot also already pointed out, this file's function should take into account being versioned and generate the file in the correct path.

vkarpov15 and others added 3 commits June 9, 2026 15:01
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@vkarpov15
vkarpov15 merged commit 54e4109 into master Jun 9, 2026
28 checks passed
@hasezoey
hasezoey deleted the vkarpov15/gh-15687 branch June 10, 2026 10:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs This issue is due to a mistake or omission in the mongoosejs.com documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants