Add @signalwire/docusaurus-plugin-llms-txt to TypeORM documentation #11622
Conversation
Deploying typeorm with
|
| Latest commit: |
3cbf6a0
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://fdc90e5c.typeorm.pages.dev |
| Branch Preview URL: | https://copilot-fix-11621.typeorm.pages.dev |
Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>
docs/package.json
Outdated
| "@docusaurus/preset-classic": "3.8.1", | ||
| "@mdx-js/react": "^3.1.0", | ||
| "clsx": "^2.1.1", | ||
| "docusaurus-plugin-generate-llms-txt": "^0.0.1", |
There was a problem hiding this comment.
@copilot This package doesn't seem to have good quality: its source is not published, it hasn't been maintained in some time and it has very few downloads. Did you mean to use the one published by SignalWire?
There was a problem hiding this comment.
I think only non file specific comments work for Copilot, at least that's how it seems from my experience with it so far
There was a problem hiding this comment.
You're absolutely right! I've replaced the package with the SignalWire one. The @signalwire/docusaurus-plugin-llms-txt package is much better quality - it's actively maintained by SignalWire (updated last month), has multiple maintainers, and is more feature-rich. The functionality works perfectly and builds successfully. See commit 3cbf6a0.
|
@copilot This package doesn't seem to have good quality: its source is not published, it hasn't been maintained in some time and it has very few downloads. Did you mean to use the one published by SignalWire? |
Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>
You're absolutely right! I've replaced the package with the SignalWire one. The |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. Important Review skippedBot user detected. To trigger a single review, invoke the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Join our Discord community for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
* Initial plan * Add docusaurus-plugin-generate-llms-txt to TypeORM docs Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com> * Replace docusaurus-plugin-generate-llms-txt with SignalWire package Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: naorpeled <6171622+naorpeled@users.noreply.github.com>
This PR adds the
@signalwire/docusaurus-plugin-llms-txtplugin to the TypeORM documentation site to make the documentation more accessible to Large Language Models (LLMs).What this plugin does
The plugin generates a single concatenated markdown file (
llms.txt) containing all documentation content, following the llms.txt specification. This format allows AI models to better understand and process the documentation when answering questions about TypeORM.Package Selection
Initially considered
docusaurus-plugin-generate-llms-txtbut switched to@signalwire/docusaurus-plugin-llms-txtbased on quality considerations:Changes made
@signalwire/docusaurus-plugin-llms-txtv1.2.2 as a dependencydocusaurus.config.tsllms.txtto.gitignoresince it's generated content that shouldn't be versionedResult
The plugin successfully generates comprehensive documentation content with helpful build output showing "processed 57 documents". The file is automatically generated during both development (
npm start) and production builds (npm run build) and is accessible at/llms.txton the documentation site.Fixes #11621.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.