feat: generate llms-full.txt from versioned documentation #360
+274
−1
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
2 tasks
Fdawgs
reviewed
Dec 11, 2025
Co-authored-by: Frazer Smith <[email protected]> Signed-off-by: Yerzhan <[email protected]>
ilteoood
requested changes
Dec 14, 2025
Contributor
ilteoood
left a comment
ilteoood
left a comment
There was a problem hiding this comment.
Would be maybe great to have a sort of test for this script?
Just to make it more maintainable in the future.
| try { | ||
| const versionsContent = await fs.readFile(VERSIONS_FILE, 'utf8') | ||
| versions = JSON.parse(versionsContent) | ||
| if (!versions || versions.length === 0) { |
Contributor
There was a problem hiding this comment.
Suggested change
| if (!versions || versions.length === 0) { | |
| if (!versions?.length) { |
Comment on lines
+154
to
+157
| let output = '' | ||
|
|
||
| // Add metadata header | ||
| output += generateMetadata(latestVersion) |
Contributor
There was a problem hiding this comment.
Suggested change
| let output = '' | |
| // Add metadata header | |
| output += generateMetadata(latestVersion) | |
| // Add metadata header | |
| let output = generateMetadata(latestVersion) |
|
|
||
| output += '## Introduction\n\n' | ||
| output += cleaned | ||
| output += '\n\n---\n\n' |
Contributor
There was a problem hiding this comment.
can you extract this in a const?
named something like SECTION_SEPARATOR or whatever you think is best, so you can reuse it in the whole file without repetitions
Contributor
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
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.
Description
This PR adds automatic generation of
llms-full.txt, an LLM-optimized documentation file that aggregates all Fastify documentation into a single text file suitable for consumption by Large Language Models.Changes include:
scripts/generate-llms-txt.jsthat combines versioned docs into a single filescripts/build-website.sh.gitignoreto exclude generated.txtfilesstatic/generated/llms-full.txtwith metadata, guides, and API reference documentationThe generated file includes proper structure with metadata headers, versioning info, and organized sections for better LLM comprehension.
Related Issues
Fixes #288
Check List