Generate a llms-full version of the docs #3285
Merged
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
🦋 Changeset detectedLatest commit: 0c0041e The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
Summary of the deployments: Version 1
Version 2
Test content |
|
The latest updates on your projects. Learn more about Argos notifications ↗︎
|
This reverts commit 3c05a65.
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new "llms-full.txt" endpoint that streams a full version of the documentation in Markdown format and updates related tests and utility functions.
- Updated llms endpoint to deliver Markdown content
- Added a new route (llms-full.ts) that streams Markdown, including parsing and link transformation
- Added tests and updated dependencies to support new Markdown processing features
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| packages/gitbook/src/routes/llms.ts | Updated Content-Type header for the llms endpoint to serve Markdown |
| packages/gitbook/src/routes/llms-full.ts | New route that streams a full Markdown version of the docs |
| packages/gitbook/src/lib/urls.ts | Added utility functions for checking external URLs and anchors using updated URL API |
| packages/gitbook/package.json | Updated package versions for Markdown and AST utilities |
| packages/gitbook/e2e/internal.spec.ts | Added tests to verify the new llms and llms-full endpoints |
| packages/gitbook-v2/src/app/sites/static/[mode]/[siteURL]/[siteData]/llms-full.txt/route.ts | New static route forwarding to the llms-full endpoint |
| .changeset/orange-hounds-sparkle.md | Changeset file describing the new llms-full feature |
Comments suppressed due to low confidence (3)
packages/gitbook/src/routes/llms.ts:49
- Ensure that consuming clients expecting plain text are updated to handle Markdown content.
'Content-Type': 'text/markdown; charset=utf-8',
packages/gitbook/src/lib/urls.ts:16
- Since URL.canParse is a new API method, consider adding a brief inline comment to clarify its behavior for future maintainers.
return URL.canParse(input);
packages/gitbook/src/routes/llms-full.ts:124
- Confirm that the combination of basePath and siteSpace.path handles trailing slashes correctly to avoid malformed URLs.
joinPath(basePath, siteSpace.path)
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.
No description provided.