Skip to content

Conversation

@Xe
Copy link
Contributor

@Xe Xe commented Sep 19, 2025

Adds llms.txt support for Tigris, allowing AI agents to better understand the documentation.

@Xe Xe self-assigned this Sep 19, 2025
@vercel
Copy link

vercel bot commented Sep 19, 2025

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

Project Deployment Preview Comments Updated (UTC)
docs-redirect Ready Ready Preview Comment Sep 19, 2025 4:19pm
tigris-os-docs Ready Ready Preview Comment Sep 19, 2025 4:19pm

Copy link
Contributor

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

Greptile Summary

This PR implements support for the llms.txt standard by integrating the docusaurus-plugin-generate-llms-txt plugin into the Tigris documentation site. The plugin automatically generates a single consolidated markdown file at /llms.txt containing all documentation content in an AI-friendly format.

The implementation involves three key changes:

  1. Package dependency: Adds the docusaurus-plugin-generate-llms-txt plugin (version ^0.0.1) to package.json
  2. Plugin configuration: Integrates the plugin into the Docusaurus configuration with minimal setup, specifying only the output filename
  3. Version control: Properly excludes the generated static/llms.txt file from Git tracking since it should be regenerated during each build

This change fits well within the existing Docusaurus-based documentation architecture. The plugin follows standard Docusaurus extension patterns and generates the file during the build process, making it available at /docs/llms.txt for AI agents and language models to consume. The llms.txt format provides a standardized way for AI systems to access comprehensive documentation content in a single, parseable file, which enhances the discoverability and usability of Tigris documentation for AI-powered tools and assistants.

Confidence score: 3/5

  • This PR introduces a dependency on a very early-stage plugin (version 0.0.1) which may have stability or compatibility issues
  • Score reflects concerns about using an untested plugin version in production, though the functionality itself is straightforward
  • Pay close attention to package.json and docusaurus.config.js for potential plugin compatibility issues

3 files reviewed, 1 comment

Edit Code Review Bot Settings | Greptile

[
"docusaurus-plugin-generate-llms-txt",
{
outputFile: "llms.txt", // defaults to llms.txt if not specified
Copy link
Contributor

Choose a reason for hiding this comment

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

style: The comment stating 'defaults to llms.txt if not specified' makes this configuration redundant - could be removed for cleaner config.

@Xe Xe merged commit 3c7ac23 into main Sep 19, 2025
10 checks passed
@Xe Xe deleted the Xe/llms-txt branch September 19, 2025 20:20
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.

3 participants