Skip to content

Conversation

nikgraf
Copy link
Collaborator

@nikgraf nikgraf commented Jul 29, 2025

No description provided.

Copy link
Contributor

@Copilot 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 adds automatic generation of an llms.txt file from the documentation using a Docusaurus plugin. The llms.txt format is designed to provide LLMs with structured access to project documentation.

  • Adds the docusaurus-plugin-generate-llms-txt package as a dependency
  • Configures the plugin to generate an llms.txt file in the static directory
  • Updates gitignore to exclude the generated file from version control

Reviewed Changes

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

File Description
docs/package.json Adds the docusaurus-plugin-generate-llms-txt dependency
docs/docusaurus.config.js Configures the plugin to generate llms.txt output
docs/.gitignore Excludes the generated llms.txt file from version control
Files not reviewed (1)
  • pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (1)

docs/package.json:21

  • The version ^0.0.1 appears to be a very early version. Please verify this package exists and consider using a more stable version if available.
    "docusaurus-plugin-generate-llms-txt": "^0.0.1",

@nikgraf nikgraf requested a review from cmwhited July 29, 2025 15:53
@nikgraf nikgraf merged commit c7af951 into main Jul 29, 2025
6 checks passed
@nikgraf nikgraf deleted the ng/generate-llmtxt-from-docs branch July 29, 2025 20:33
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