-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
docs: improve llms.txt module descriptions #59264
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
araujogui
wants to merge
7
commits into
nodejs:main
Choose a base branch
from
araujogui:doc/improve-llms-txt
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
+185
−0
Conversation
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
Review requested:
|
587f097
to
4e9b657
Compare
himself65
approved these changes
Jul 29, 2025
jasnell
approved these changes
Jul 29, 2025
aduh95
reviewed
Jul 29, 2025
184e15a
to
bd24fe4
Compare
4 tasks
Some fixes are in the way |
284e3d9
to
5c5da8f
Compare
@aduh95 can you review? please |
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.
Previously, I implemented an
llms.txt
generator in the new API docs tooling (nodejs/doc-kit#254). It searches for anllm_description
YAML node or falls back to the first paragraph of the module documentation.This PR adds
llm_description
nodes to provide meaningful descriptions of the module entries in thellms.txt
file.