chore(docs): ehnance llms.txt#11711
Conversation
Deploying typeorm with
|
| Latest commit: |
33ea91c
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://93da5de0.typeorm.pages.dev |
| Branch Preview URL: | https://chore-docs-improve-llms-txt.typeorm.pages.dev |
WalkthroughAdds llms-full.txt to docs/.gitignore and updates Docusaurus configuration to replace a simple llms-txt plugin entry with a fully configured plugin object specifying selectors, generation of llms.txt and llms-full.txt, inclusion rules, depth, error handling, and site metadata. Changes
Sequence Diagram(s)sequenceDiagram
autonumber
actor Dev as Developer
participant D as Docusaurus Core
participant P as llms-txt Plugin
participant FS as File System
Dev->>D: docusaurus build
D->>P: Initialize with options<br/>(contentSelectors, include*, depth, relativePaths, onRouteError,<br/>siteTitle, siteDescription)
Note over P: Validates options (satisfies LLMsTXTPluginOptions)
D->>P: Traverse routes and content
P->>P: Select content per selectors<br/>and inclusion flags
alt Route/content error
P-->>D: onRouteError callback
end
P->>FS: Write llms.txt
P->>FS: Write llms-full.txt (enabled)
D-->>Dev: Build complete
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/docusaurus.config.ts (1)
201-227: Comprehensive plugin configuration looks good.The llms-txt plugin configuration is well-structured with appropriate options:
contentSelectorsinclude Docusaurus-specific selectors (.theme-doc-markdown,.theme-doc-wrapper) and sensible fallbacksenableLlmsFullTxt: truealigns with the.gitignoreadditionincludeVersionedDocs: falseis consistent with the current single-locale setuponRouteError: "throw"ensures the build fails on content extraction errors, which is good for catching issues early- Site metadata matches the top-level config values
Minor suggestion: Consider verifying that
depth: 3provides adequate content coverage without being too verbose for LLM consumption.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/.gitignore(1 hunks)docs/docusaurus.config.ts(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Cloudflare Pages
🔇 Additional comments (2)
docs/.gitignore (1)
11-11: LGTM!The addition of
llms-full.txtto.gitignoreis correct and consistent with the plugin configuration that enablesenableLlmsFullTxt: true.docs/docusaurus.config.ts (1)
5-5: LGTM!The import statement is correctly typed and properly used with the
satisfiesoperator on line 226.
|
@naorpeled why "initial commit"? 😄 |
Oops lol, didn't notice🤦♂️ |
Description of change
Added more information to llms.txt and added llms-full.txt
Pull-Request Checklist
masterbranchFixes #00000Summary by CodeRabbit
Documentation
Chores
Refactor