Skip to content

docs: generate llms.txt and llms-full.txt via vitepress-plugin-llms#290

Merged
vihar merged 2 commits into
masterfrom
docs/llms-txt-plugin
Jun 18, 2026
Merged

docs: generate llms.txt and llms-full.txt via vitepress-plugin-llms#290
vihar merged 2 commits into
masterfrom
docs/llms-txt-plugin

Conversation

@sriramveeraghanta

Copy link
Copy Markdown
Member

What

Replaces the hand-maintained static llms.txt / llms-full.txt with build-time generation via vitepress-plugin-llms, served at:

Both are emitted into the gitignored dist/ on every pnpm build, so they always stay in sync with the docs — nothing to maintain by hand.

How

Wired into vite.plugins in docs/.vitepress/config.mts, mirroring makeplane/docs#465:

  • domainhttps://developers.plane.so for absolute URLs (matches the old file and robots.txt).
  • title / description / details → spec-compliant blockquote + summary header.
  • generateLLMFriendlyDocsForEachPage: false — the existing buildEnd hook already copies per-page .md into dist/ for the Accept: text/markdown rewrite in vercel.json, so the plugin owns only the two aggregate files (no overlap).
  • injectLLMHint: false — rendered pages left untouched.
  • ignoreFiles — the two search: false / noindex commercial install pages (docker-compose, kubernetes under install-methods-commercial) are excluded, matching their search-engine treatment.
  • Deleted the stale static docs/public/llms.txt and docs/public/llms-full.txt; the plugin is now the single source of truth.

Output

  • llms.txt: 334 documentation links (~21.3K tokens, ~78 kB)
  • llms-full.txt: 334 pages (~324K tokens, ~1.31 MB)
  • Home page excluded (plugin default); the two noindex pages excluded.

Notes

  • pnpm build and pnpm check:format both pass.
  • Per-page raw .md (with full API-page content) continues to be served by the kept buildEnd hook.

Replace the hand-maintained static llms.txt / llms-full.txt with build-time
generation using vitepress-plugin-llms, so the AI-friendly docs stay in sync
with the site automatically.

- Add vitepress-plugin-llms (dev dependency) wired into vite.plugins.
- domain set to https://developers.plane.so for absolute URLs.
- description / details provide a spec-compliant blockquote + summary.
- generateLLMFriendlyDocsForEachPage: false — the existing buildEnd hook
  already copies per-page .md into dist/ for the `Accept: text/markdown`
  rewrite in vercel.json, so the plugin owns only the two aggregate files.
- injectLLMHint: false — rendered pages left untouched.
- ignoreFiles excludes the two search: false / noindex commercial install
  pages, matching their search-engine treatment.
- Delete the stale static docs/public/llms.txt and llms-full.txt; the plugin
  is now the single source of truth.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 18, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
developer-docs Ready Ready Preview, Comment Jun 18, 2026 7:58pm

Request Review

@coderabbitai

coderabbitai Bot commented Jun 18, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@sriramveeraghanta, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 45 minutes and 47 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 691fe8a9-3337-4ad5-85fa-f9f480463acb

📥 Commits

Reviewing files that changed from the base of the PR and between f979242 and 568b240.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • docs/.vitepress/config.mts
  • docs/public/llms-full.txt
  • docs/public/llms.txt
  • package.json
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/llms-txt-plugin

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.

@sriramveeraghanta sriramveeraghanta changed the base branch from preview to master June 18, 2026 19:50
…s/llms-txt-plugin

# Conflicts:
#	docs/.vitepress/config.mts
#	package.json
#	pnpm-lock.yaml
@vihar vihar merged commit 8d585db into master Jun 18, 2026
8 checks passed
@vihar vihar deleted the docs/llms-txt-plugin branch June 18, 2026 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants