Skip to content

Switch llms.txt generation to SignalWire plugin - #3971

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

Switch llms.txt generation to SignalWire plugin#3971
thomhurst merged 1 commit into
mainfrom
agent/switch-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 1.2.2
  • migrate configuration to SignalWire plugin options while preserving llms.txt, per-page Markdown, and llms-full.txt generation
  • update npm and Yarn lockfiles

Why

Use the maintained SignalWire plugin requested for documentation LLM exports without changing generated output coverage.

Validation

  • yarn typecheck
  • yarn docusaurus build
  • build processed 326 documents and generated both llms.txt and llms-full.txt

Summary by CodeRabbit

  • Documentation
    • Improved documentation export support.
    • Added Markdown output and generated a comprehensive llms-full.txt file.
    • Updated site metadata used in generated documentation content.

@coderabbitai

coderabbitai Bot commented Aug 17, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 30e8ffbe-7d04-4756-8136-aad9f6b8ccd2

📥 Commits

Reviewing files that changed from the base of the PR and between 8f8aeb4 and 8ad3917.

⛔ Files ignored due to path filters (2)
  • docs/package-lock.json is excluded by !**/package-lock.json
  • docs/yarn.lock is excluded by !**/yarn.lock, !**/*.lock
📒 Files selected for processing (2)
  • docs/docusaurus.config.ts
  • docs/package.json
 ____________________________________________________________________________________________________________________________________
< Put abstractions in code, details in metadata. Program for the general case, and put the specifics outside the compiled code base. >
 ------------------------------------------------------------------------------------------------------------------------------------
  \
   \   \
        \ /\
        ( )
      .( o ).
✨ 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/switch-signalwire-llms-plugin

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

@thomhurst
thomhurst merged commit 81304ae into main Aug 17, 2026
13 of 15 checks passed
@thomhurst
thomhurst deleted the agent/switch-signalwire-llms-plugin branch August 17, 2026 16:40
@claude

claude Bot commented Aug 17, 2026

Copy link
Copy Markdown

Code review

No issues found. Checked for bugs and CLAUDE.md compliance.

This is a clean, well-scoped swap of docusaurus-plugin-llms for the actively-maintained @signalwire/docusaurus-plugin-llms-txt:

  • The config migration in docs/docusaurus.config.ts correctly remaps the old flat options (generateLLMsTxt, generateLLMsFullTxt, title, description) to the new plugin's shape (siteTitle, siteDescription, content.enableMarkdownFiles, content.enableLlmsFullTxt), and the satisfies PluginOptions annotation gives compile-time safety against future API drift in the plugin.
  • No stale references to the old docusaurus-plugin-llms package remain anywhere in the repo (config, docs, CI).
  • package.json/package-lock.json/yarn.lock are updated consistently, and the PR description notes yarn typecheck and yarn docusaurus build were run, generating both llms.txt and llms-full.txt as before — so output coverage is preserved.
  • No CLAUDE.md files apply to this docs-only change beyond the root file, which governs the .NET build system and isn't implicated here.

Nothing architectural to flag — this is a straightforward, low-risk dependency substitution with matching config semantics.

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