docs: llms.txt by dinwwwh · Pull Request #272 · middleapi/orpc

dinwwwh · 2025-03-20T02:45:04Z

Summary by CodeRabbit

New Features
- Integrated a new plugin that extends the application's capabilities.
Chores
- Updated the development dependencies to support the added functionality.

vercel · 2025-03-20T02:45:08Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
orpc	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Mar 20, 2025 2:45am

coderabbitai · 2025-03-20T02:45:13Z

Walkthrough

The changes integrate the llmstxt plugin from the vitepress-plugin-llms package into the project. The plugin is imported in the VitePress configuration file (config.ts) and its initialization function, llmstxt(), is added to the plugins array. Additionally, the plugin has been added as a dependency in package.json under devDependencies. The overall configuration structure remains intact with the new functionality merged alongside existing settings.

Changes

File(s)	Change Summary
`apps/content/.vitepress/config.ts`, `apps/content/package.json`	Integrated `llmstxt` from `vitepress-plugin-llms`: imported and invoked `llmstxt()` in the VitePress config, and added `"vitepress-plugin-llms": "^0.0.6"` in devDependencies.

Sequence Diagram(s)

sequenceDiagram
    participant V as VitePress
    participant C as Config File
    participant P as llmstxt Plugin

    V->>C: Load configuration file
    C->>P: Call llmstxt() to initialize plugin
    P-->>C: Plugin initializes successfully
    C->>V: Return enhanced configuration

Poem

I am a bunny, swift and spry,
Hopping in code under a bright sky.
A new plugin joins the parade,
llmstxt in the config has been laid.
With joyful hops, I cheer the change,
In this coding garden, nothing is strange!
🐇✨

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a4ecb29 and 1900374.

⛔ Files ignored due to path filters (1)

pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (2)

apps/content/.vitepress/config.ts (2 hunks)
apps/content/package.json (1 hunks)

🔇 Additional comments (3)

apps/content/package.json (1)

35-35: Added vitepress-plugin-llms dependency

The dependency vitepress-plugin-llms version ^0.0.6 has been added to the project's devDependencies. This package enables the llms.txt plugin for VitePress.
apps/content/.vitepress/config.ts (2)

4-4: Imported llmstxt plugin

The llmstxt plugin is imported from 'vitepress-plugin-llms' package to enhance VitePress functionality.

212-212:
Details

✅ Verification successful

Added llmstxt() to plugins

The llmstxt plugin function has been correctly added to the Vite plugins array, enabling the LLMs.txt functionality in the documentation site.

🌐 Web query:
What is vitepress-plugin-llms and what does it add to a VitePress site?
💡 Result:

vitepress-plugin-llms enhances VitePress documentation sites by optimizing content consumption for Large Language Models (LLMs) through the implementation of the llms.txt specification. This plugin adds several key capabilities to standard VitePress installations:

Core Features

Automated LLM-Friendliness
Generates and maintains:

/llms.txt root file describing documentation structure

Markdown equivalents for all routes (e.g., /about.html → /about.md)

Clean content versions without theme/UI elements[1][11]

Project Structure Integration
Maintains documentation hierarchy automatically:
your-project/
├─ docs/
│  ├─ .vitepress/
│  ├─ components/
│  └─ content/
│     ├─ guide.md     → /guide.html & /guide.md
│     └─ api.md       → /api.html & /api.md
Technical Implementation
// vite.config.js
import { defineConfig } from 'vite'
import llms from 'vitepress-plugin-llms'

export default defineConfig({
  plugins: [
    llms({
      contentDir: 'docs/content', // Default
      outputStrategy: 'mirror'    // Options: mirror|flat|hybrid
    })
  ]
})
Key Benefits

Feature Benefit

Dual Format Output HTML for humans + MD for LLMs

Structural Mirroring Maintains URL parity between formats

AI Navigation Support Helps LLMs understand documentation hierarchy

Future-Proofing Prepares for AI-first development workflows

The plugin addresses growing needs for LLM-accessible documentation outlined in VitePress community discussions[6][10], particularly for technical documentation being indexed by AI coding assistants. It differs from general-purpose markdown plugins by specifically optimizing content structure and metadata for machine consumption while maintaining standard Vitepress functionality[11][1].

Citations:

1: https://dev.to/seniuk/make-your-vite-project-llm-friendly-with-vite-plugin-llms-4k3p

2: https://advanced-stack.com/resources/how-to-setup-vitepress-mermaid-plugin.html

3: https://vitepress.dev/guide/what-is-vitepress

4: https://vitepress.dev/guide/getting-started

5: https://developers.cloudflare.com/pages/framework-guides/deploy-a-vitepress-site/

6: Support indexing by an LLM vuejs/vitepress#4545

7: https://vitepress.dev/guide/markdown

8: https://servicestack.net/posts/vite-press-plugin

9: https://docs.modx.pro/en/guide/vitepress

10: Create llms.txt for vite.dev vitejs/vite#19400

11: https://github.com/aklinker1/vitepress-knowledge

12: https://www.npmjs.com/~nekomeowww
Verified: LLMtxt Plugin Integration Works as Expected

The llmstxt() function has been correctly added to the Vite plugins array in apps/content/.vitepress/config.ts. This integration enables the generation of the /llms.txt file along with machine-friendly markdown outputs, aligning with the core capabilities of the vitepress-plugin-llms. The verification confirms that the plugin optimizes your VitePress documentation site for large language models by providing enhanced LLM accessibility without interfering with standard site functionality.

The plugin automatically generates a llms.txt file and corresponding markdown files for enhanced LLM processing.

Integration aligns with documented best practices for optimizing documentation structure for AI processing.

✨ Finishing Touches

📝 Generate Docstrings

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

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

codecov · 2025-03-20T02:46:05Z

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

pkg-pr-new · 2025-03-20T02:46:36Z

Open in Stackblitz

More templates

@orpc/arktype

npm i https://pkg.pr.new/@orpc/arktype@272

@orpc/client

npm i https://pkg.pr.new/@orpc/client@272

@orpc/contract

npm i https://pkg.pr.new/@orpc/contract@272

@orpc/openapi

npm i https://pkg.pr.new/@orpc/openapi@272

@orpc/openapi-client

npm i https://pkg.pr.new/@orpc/openapi-client@272

@orpc/react-query

npm i https://pkg.pr.new/@orpc/react-query@272

@orpc/server

npm i https://pkg.pr.new/@orpc/server@272

@orpc/shared

npm i https://pkg.pr.new/@orpc/shared@272

@orpc/solid-query

npm i https://pkg.pr.new/@orpc/solid-query@272

@orpc/standard-server

npm i https://pkg.pr.new/@orpc/standard-server@272

@orpc/standard-server-fetch

npm i https://pkg.pr.new/@orpc/standard-server-fetch@272

@orpc/standard-server-node

npm i https://pkg.pr.new/@orpc/standard-server-node@272

@orpc/svelte-query

npm i https://pkg.pr.new/@orpc/svelte-query@272

@orpc/valibot

npm i https://pkg.pr.new/@orpc/valibot@272

@orpc/vue-colada

npm i https://pkg.pr.new/@orpc/vue-colada@272

@orpc/vue-query

npm i https://pkg.pr.new/@orpc/vue-query@272

@orpc/zod

npm i https://pkg.pr.new/@orpc/zod@272

commit: 1900374

docs: llm

1900374

vercel bot temporarily deployed to Preview March 20, 2025 02:45 Inactive

dinwwwh merged commit a8e421c into main Mar 20, 2025
8 checks passed

coderabbitai bot mentioned this pull request Apr 10, 2025

chore(deps): update vitepress-plugin-llms to 1.1.0 #361

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs: llms.txt#272

docs: llms.txt#272
dinwwwh merged 1 commit intomainfrom
docs/llm

dinwwwh commented Mar 20, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Mar 20, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Mar 20, 2025 •

edited

Loading

Core Features

Technical Implementation

Key Benefits

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Mar 20, 2025

Uh oh!

pkg-pr-new bot commented Mar 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Conversation

dinwwwh commented Mar 20, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Mar 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Poem

Core Features

Technical Implementation

Key Benefits

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Mar 20, 2025

Codecov Report

Uh oh!

pkg-pr-new bot commented Mar 20, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

dinwwwh commented Mar 20, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Mar 20, 2025 •

edited

Loading

coderabbitai bot commented Mar 20, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)