Skip to content

Switch to SignalWire llms.txt plugin - #6627

Merged
thomhurst merged 1 commit into
mainfrom
agent/use-signalwire-llms-plugin
Aug 17, 2026
Merged

Switch to SignalWire llms.txt plugin#6627
thomhurst merged 1 commit into
mainfrom
agent/use-signalwire-llms-plugin

Conversation

@thomhurst

@thomhurst thomhurst commented Aug 17, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace docusaurus-plugin-llms with @signalwire/docusaurus-plugin-llms-txt
  • update Docusaurus plugin configuration
  • refresh the Yarn lockfile

Why

Use the SignalWire-maintained plugin for generating LLM-friendly documentation and the llms.txt index.

Impact

Documentation builds now generate llms.txt through the SignalWire plugin. The production build processed 123 documents successfully.

Validation

  • yarn typecheck
  • yarn build

Summary by CodeRabbit

  • Documentation
    • Updated documentation tooling to improve compatibility with LLM-readable text output.
    • Documentation builds now use the latest supported LLMs text plugin.

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: cc438799-9157-422f-8219-453bb63e66f6

📥 Commits

Reviewing files that changed from the base of the PR and between 64d8328 and 7f03756.

⛔ Files ignored due to path filters (1)
  • docs/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • docs/docusaurus.config.ts
  • docs/package.json

Included review availability: Your plan includes up to 3 reviews per rolling hour; 2 remain after this review.


📝 Walkthrough

Walkthrough

The documentation site replaces docusaurus-plugin-llms with @signalwire/docusaurus-plugin-llms-txt version ^1.2.2 in its dependency and Docusaurus plugin configuration.

Changes

LLM Documentation Plugin Update

Layer / File(s) Summary
Configure the LLMs text plugin
docs/package.json, docs/docusaurus.config.ts
The documentation dependency and Docusaurus plugin configuration now use @signalwire/docusaurus-plugin-llms-txt version ^1.2.2.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk: ⚪ Minimal · up to 7f037

This localized documentation build change has no actionable merge-blocking risk remaining beyond normal checks and review.

Poem

I’m a rabbit with docs in my paws,
The plugin now follows new laws.
LLM text flows bright,
Configured just right,
While I nibble code-carrot applause.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely identifies the switch to the SignalWire llms.txt plugin, which is the main change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch agent/use-signalwire-llms-plugin

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

@claude

claude Bot commented Aug 17, 2026

Copy link
Copy Markdown
Contributor

Code Review — PR #6627

Scope: 3 files — docs/docusaurus.config.ts, docs/package.json, docs/yarn.lock. This swaps the Docusaurus LLMs-plugin package from docusaurus-plugin-llms@^0.5.1 to @signalwire/docusaurus-plugin-llms-txt@^1.2.2, updating the plugin registration string, the dependency version, and the corresponding lockfile entries.

Verification performed:

  • Plugin string updated consistently in both docusaurus.config.ts (plugin list) and package.json (dependency).
  • No other file in the repo (docs pages, CI workflows, scripts) still references the old package name docusaurus-plugin-llms.
  • Full yarn.lock diff reviewed: the old package and its now-unused transitive deps (gray-matter, js-yaml@^3, argparse@^1, esprima) were cleanly removed, and the new package's transitive tree (hast-util-*, rehype-*, unified, etc.) was added consistently with correct integrity hashes — a normal, self-consistent yarn install regeneration with no stray unrelated bumps.
  • Neither the old nor new plugin registration in docusaurus.config.ts passes an options object, so there's no plugin-specific config to migrate and no silent behavior change from dropped options.
  • No CLAUDE.md rule (dual-mode metadata, snapshot testing, VSTest, AOT) applies — this is a docs-tooling dependency swap, not engine/source-generator code, and no .verified.txt/.received.txt files are involved.

Verdict: Minimal, low-risk chore change, consistent with its own commit message (chore(docs): switch llms.txt plugin). No correctness, design, or maintainability issues found — approving as-is.

@greptile-apps

greptile-apps Bot commented Aug 17, 2026

Copy link
Copy Markdown

Greptile Summary

The PR replaces the existing LLM documentation plugin with SignalWire’s maintained plugin and refreshes the corresponding Yarn dependency graph.

  • Registers @signalwire/docusaurus-plugin-llms-txt in the Docusaurus configuration.
  • Replaces the previous development dependency with version ^1.2.2.
  • Updates the Yarn v1 lockfile with the new plugin’s resolved, integrity-protected dependency tree.

Confidence Score: 5/5

The PR appears safe to merge, with no concrete build, runtime, output-contract, or security defect identified.

The plugin registration, package manifest, lockfile, Node runtime, and frozen CI installation path are consistent, and the reported typecheck and production build validation cover the changed documentation build path.

Important Files Changed

Filename Overview
docs/docusaurus.config.ts Replaces the bare Docusaurus plugin registration with the SignalWire package; no configuration mismatch or broken output path was established.
docs/package.json Swaps the old LLM plugin dependency for @signalwire/docusaurus-plugin-llms-txt while retaining the existing Node and Docusaurus setup.
docs/yarn.lock Removes the old plugin graph and records the new plugin and transitive dependencies with concrete versions and integrity hashes.

Reviews (1): Last reviewed commit: "chore(docs): switch llms.txt plugin" | Re-trigger Greptile

@thomhurst
thomhurst merged commit bc20d78 into main Aug 17, 2026
@thomhurst
thomhurst deleted the agent/use-signalwire-llms-plugin branch August 17, 2026 16:35
This was referenced Aug 18, 2026
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.

1 participant