feat: Add docusaurus-plugin-llms for enhanced documentation generation#598
feat: Add docusaurus-plugin-llms for enhanced documentation generation#598fairlighteth wants to merge 2 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
📝 WalkthroughWalkthroughAdds the "docusaurus-plugin-llms" plugin and devDependency, configures it to generate llms.txt and llms-full.txt, exclude imports and duplicate headings, ignore specified files/paths, and introduces a new docs page describing llms.txt usage. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/llms.md`:
- Line 24: The Windsurf documentation link in the docs/llms.md entry is broken
(404); locate the Windsurf URL near the existing "See [Cursor
docs](https://docs.cursor.com/context/@-symbols/@-docs)" line and replace the
invalid Windsurf docs URL with the correct, valid Windsurf documentation page
(verify the target by opening it in a browser to confirm no 404), updating the
markdown link so the Windsurf reference resolves correctly.
|
|
||
| Use the `@Docs` feature to add the llms.txt URL as a documentation source. This gives Cursor accurate context about CoW Protocol, CoW AMM, and Governance when generating code suggestions. | ||
|
|
||
| See [Cursor docs](https://docs.cursor.com/context/@-symbols/@-docs) for more details. |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# First, check the file content at the specified lines
echo "=== File content check ==="
cat -n docs/llms.md | sed -n '20,35p'Repository: cowprotocol/docs
Length of output: 958
🏁 Script executed:
#!/bin/bash
# Verify URL accessibility
echo "Checking Cursor docs URL..."
curl -I -s -o /dev/null -w "HTTP %{http_code}\n" https://docs.cursor.com/context/@-symbols/@-docs
echo "Checking Windsurf docs URL..."
curl -I -s -o /dev/null -w "HTTP %{http_code}\n" https://docs.windsurf.com/windsurf/memoriesRepository: cowprotocol/docs
Length of output: 135
Fix broken Windsurf documentation URL.
The Windsurf documentation URL on line 30 returns HTTP 404 (not found). The Cursor documentation URL on line 24 is accessible. Please verify and update the Windsurf URL to point to a valid documentation page.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/llms.md` at line 24, The Windsurf documentation link in the docs/llms.md
entry is broken (404); locate the Windsurf URL near the existing "See [Cursor
docs](https://docs.cursor.com/context/@-symbols/@-docs)" line and replace the
invalid Windsurf docs URL with the correct, valid Windsurf documentation page
(verify the target by opening it in a browser to confirm no 404), updating the
markdown link so the Windsurf reference resolves correctly.
Description
Adds the
docusaurus-plugin-llmsplugin to generatellms.txtandllms-full.txtfiles at build time, following the llmstxt.org standard. This makes our documentation easily consumable by LLMs and AI-poweredtools by providing structured, plain-text representations of the full docs site.
Also adds a dedicated docs page explaining the available files and how to use them with popular AI tools like Cursor and Windsurf.
Changes
docusaurus-plugin-llms@0.3.0as a dev dependencydocusaurus.config.tswith the following options:excludeImports: trueto strip MDX import statements from outputremoveDuplicateHeadings: trueto clean up redundant headingsignoreFiles: ['mevblocker/**']to exclude deprecated MEV Blocker docspathTransformation.ignorePaths: ['docs']to produce correct URLs (sincerouteBasePathis/)docs/llms.mdpage with usage instructions for Cursor, Windsurf, and other AI toolsAfter deployment, files will be available at:
Summary by CodeRabbit