Skip to content

chore(docs): ehnance llms.txt #11711

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
naorpeled merged 2 commits into from
Oct 3, 2025
Merged

chore(docs): ehnance llms.txt #11711

naorpeled merged 2 commits into from
Oct 3, 2025
+29 −1

Conversation

@naorpeled
Copy link
Member

@naorpeled naorpeled commented Oct 3, 2025 •
edited by coderabbitai bot
Loading

Description of change

Added more information to llms.txt and added llms-full.txt

Pull-Request Checklist

  • Code is up-to-date with the master branch
  • This pull request links relevant issues as Fixes #00000
  • There are new or updated unit tests validating the change
  • Documentation has been updated to reflect this change

Summary by CodeRabbit

  • Documentation

    • Configured a content mapping generator with detailed options (content selectors, inclusion of pages and versioned docs, relative paths, depth, route error handling).
    • Added site title and description in the configuration to enrich generated outputs.

  • Chores

    • Updated ignore rules to exclude both standard and full text map files from version control.

  • Refactor

    • Replaced a minimal plugin entry with a structured configuration block for finer control and validation.

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Oct 3, 2025 •
edited
Loading

Deploying typeorm with  Cloudflare Pages  Cloudflare Pages

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

View logs

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 3, 2025 •
edited
Loading

Walkthrough

Adds 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

Cohort / File(s) Summary
Ignore rules
docs/.gitignore		 Added llms-full.txt to ignored files alongside llms.txt.
Docusaurus plugin configuration
docs/docusaurus.config.ts		 Replaced string plugin entry with a configured @signalwire/docusaurus-plugin-llms-txt block using LLMsTXTPluginOptions; added content selectors, enabled full TXT generation, inclusion settings, depth, route error handler, relative paths, and site metadata.

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
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I nibble docs with whiskered might,
Two tasty TXT trails now in sight—
One lean, one full, both freshly spun,
From plugins dancing, crawl by run.
I thump approval, hop with glee:
Config aligned, ignore set free. 🥕🐇

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Title Check ⚠️ Warning The title contains a typo and only mentions enhancing llms.txt, failing to clearly reflect both the addition of llms-full.txt and the detailed plugin configuration updates to the documentation. Rename the PR to a concise, correctly spelled title that covers the key changes, for example: chore(docs): add llms-full.txt support and configure llms.txt plugin.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit's high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/docs/improve-llms-txt

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@naorpeled naorpeled requested review from OSA413, alumni and gioboa October 3, 2025 07:10
@naorpeled naorpeled marked this pull request as ready for review October 3, 2025 07:10
coderabbitai[bot]
coderabbitai bot reviewed Oct 3, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  • contentSelectors include Docusaurus-specific selectors (.theme-doc-markdown, .theme-doc-wrapper) and sensible fallbacks
  • enableLlmsFullTxt: true aligns with the .gitignore addition
  • includeVersionedDocs: false is consistent with the current single-locale setup
  • onRouteError: "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: 3 provides adequate content coverage without being too verbose for LLM consumption.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 74522ff and 33ea91c.

📒 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.txt to .gitignore is correct and consistent with the plugin configuration that enables enableLlmsFullTxt: true.

docs/docusaurus.config.ts (1)

5-5: LGTM!

The import statement is correctly typed and properly used with the satisfies operator on line 226.

gioboa
gioboa approved these changes Oct 3, 2025
View reviewed changes
Copy link
Collaborator

@gioboa gioboa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 🔥

@coveralls
Copy link

coveralls commented Oct 3, 2025

Coverage Status

coverage: 76.433%. remained the same
when pulling 33ea91c on chore/docs/improve-llms-txt
into 74522ff on master.

@naorpeled naorpeled merged commit 1f19abb into master Oct 3, 2025
60 checks passed
@naorpeled naorpeled deleted the chore/docs/improve-llms-txt branch October 3, 2025 10:33
@alumni
Copy link
Collaborator

alumni commented Oct 3, 2025 •
edited
Loading

@naorpeled why "initial commit"? 😄

@naorpeled
Copy link
Member Author

naorpeled commented Oct 3, 2025

@naorpeled why "initial commit"? 😄

Oops lol, didn't notice🤦‍♂️

ThbltLmr pushed a commit to ThbltLmr/typeorm that referenced this pull request Dec 2, 2025
@naorpeled @ThbltLmr
initial commit (typeorm#11711)
a03493b
mgohin pushed a commit to mgohin/typeorm that referenced this pull request Jan 15, 2026
@naorpeled
initial commit (typeorm#11711)
faba1d3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@alumni alumni alumni approved these changes

@gioboa gioboa gioboa approved these changes

@OSA413 OSA413 Awaiting requested review from OSA413

+1 more reviewer

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@naorpeled @coveralls @alumni @gioboa