Skip to content

Llms Txt#34

Merged
boneskull merged 1 commit intomainfrom
llms-txt
Feb 3, 2026
Merged

Llms Txt#34
boneskull merged 1 commit intomainfrom
llms-txt

Conversation

@boneskull
Copy link
Owner

Uses typedoc-plugin-llms-txt to generate an llms.txt.

Uses [typedoc-plugin-llms-txt](https://npm.im/typedoc-plugin-llms-txt) to generate an `llms.txt`.
@boneskull
Copy link
Owner Author

boneskull commented Feb 3, 2026

Stack


Managed by gh-stack

Copilot AI review requested due to automatic review settings February 3, 2026 03:06
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR integrates typedoc-plugin-llms-txt into the documentation build so that an llms.txt file is generated, and wires in curated metadata and examples for LLM consumption.

Changes:

  • Adds typedoc-plugin-llms-txt@0.1.2 as a dev dependency and locks it in package-lock.json.
  • Extends the TypeDoc configuration to enable the typedoc-plugin-llms-txt plugin and provide llmsTxt* options (header, quick reference, and section mappings).
  • Updates cspell.json to recognize the term llms and keep the dictionary valid.

Reviewed changes

Copilot reviewed 3 out of 4 changed files in this pull request and generated no comments.

File Description
package.json Registers typedoc-plugin-llms-txt as a devDependency alongside existing TypeDoc plugins.
package-lock.json Locks the new plugin, including its integrity hash, engine, and peer dependency metadata.
cspell.json Adds llms to the allowed words list and adjusts the trailing comma on dogg to keep JSON valid.
.config/typedoc.js Configures typedoc-plugin-llms-txt (header, quick reference snippet, sections) and adds the plugin to the TypeDoc plugin list.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@boneskull boneskull mentioned this pull request Feb 3, 2026
@boneskull boneskull merged commit b6055b8 into main Feb 3, 2026
14 checks passed
@boneskull boneskull deleted the llms-txt branch February 3, 2026 23:03
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