Docs LLM accessibility: add llms.txt, allow copying and viewing pages as markdown#581
Open
Docs LLM accessibility: add llms.txt, allow copying and viewing pages as markdown#581
llms.txt, allow copying and viewing pages as markdown#581Conversation
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
|
Amplify deployment status
|
…t the markdown output for pages
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.
The first iteration of features dedicated to providing LLMs better context of the docs site.
New features:
/docs/get-startedgets a markdown version in/docs/get-started.md)llms.txtfile (available at/docs/llms.txt)A new Docusaurus plugin,
@signalwire/docusaurus-plugin-llms-txt, is installed for the task of generating the markdown pages and thellms.txtfile. The plugin is configured in a new file/server/llms/index.ts.List of changes:
@signalwire/docusaurus-plugin-llms-txtto the list of dependencies inpackage.json@signalwire/docusaurus-plugin-llms-txtplugin to the Docusaurus plugins configuration indocusaurus.config.ts@signalwire/docusaurus-plugin-llms-txtplugin in/server/llms/index.tsrehypeplugins to/server/llms/, which are used in the@signalwire/docusaurus-plugin-llms-txtplugin:rehype-process-custom-components.ts: Used to process custom components for cleaner markdown outputrehype-remove-heading-anchor-links.ts: Prevents the automatically created heading anchor links from appearing in the markdown outputrehype-remove-irrelevant-components.ts: Prevents components not useful for AI to appear in the markdown outputrehype-reposition-h1.ts: Ensures the page title is correctly applied to the markdown version of the pagerehypeplugins.rehypeunit tests/server/fixtures/llmsPageActionscomponent to accommodate the design changes found in Figmaunist, which caused some unit tests to fail (/server/unist-augment.d.ts)