Skip to content

docs: add llms.txt file to docs#5395

Open
juliettech13 wants to merge 2 commits intomainfrom
add-llms.txt
Open

docs: add llms.txt file to docs#5395
juliettech13 wants to merge 2 commits intomainfrom
add-llms.txt

Conversation

@juliettech13
Copy link
Collaborator

Ticket

[ENG-3547] - Build out llms.txt and llms-full.txt for our documentation so AI agents more accurately generate implementations

Context

Agents were generating implementations based on our legacy integration methods. This file should improve agent's read of our documentation

Component/Service

What part of Helicone does this affect?

  • Web (Frontend)
  • Jawn (Backend)
  • Worker (Proxy)
  • Bifrost (Marketing)
  • AI Gateway
  • Packages
  • Infrastructure/Docker
  • Documentation

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update
  • Performance improvement
  • Refactoring

Testing

  • Added/updated unit tests
  • Added/updated integration tests
  • Tested locally
  • Verified in staging environment
  • E2E tests pass (if applicable)

Technical Considerations

  • Database migrations included (if needed)
  • API changes documented
  • Breaking changes noted
  • Performance impact assessed
  • Security implications reviewed

Dependencies

  • No external dependencies added
  • Dependencies added and documented
  • Environment variables added/modified

Deployment Notes

  • No special deployment steps required
  • Database migrations need to run
  • Environment variable changes required
  • Coordination with other teams needed

@vercel
Copy link

vercel bot commented Dec 11, 2025

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

Project Deployment Review Updated (UTC)
helicone Ready Ready Preview, Comment Dec 17, 2025 8:17pm
helicone-bifrost Ready Ready Preview, Comment Dec 17, 2025 8:17pm
helicone-eu Ready Ready Preview, Comment Dec 17, 2025 8:17pm

@claude
Copy link
Contributor

claude bot commented Dec 11, 2025

Claude finished @juliettech13's task —— View job


PR Review: Add llms.txt documentation files

Todo List:

  • Read and analyze docs/llms.txt file
  • Read and analyze docs/llms-full.txt file
  • Check URL references and formatting
  • Address file placement question (docs/ vs root)
  • Provide comprehensive review feedback with confidence score

Score: 9/10 - Excellent documentation addition with minor file placement consideration

This PR adds valuable llms.txt documentation files to help AI agents generate better Helicone implementations. The content is comprehensive, well-structured, and follows the llms.txt format effectively.

Suggestions Summary:

File Placement (Addresses @colegottdank's question):
The recent commit 5d05a87 moved llms-full.txt from root to docs/ directory. Both files are now in docs/:

  • docs/llms.txt (59 lines)
  • docs/llms-full.txt (1478 lines)

Recommendation: Keep both files in docs/ directory. This is the correct placement because:

  1. Consistency: Both files belong together in the same directory
  2. Organization: Documentation files should live in the docs directory
  3. URL accessibility: These will be accessible at docs.helicone.ai/llms.txt and docs.helicone.ai/llms-full.txt
  4. Future maintenance: Easier to manage when co-located with other documentation

Content Analysis:

docs/llms.txt (Index file):
Excellent structure - Clear categorization and logical flow
Comprehensive coverage - All major Helicone features included
Valid URLs - All documentation links follow correct patterns
Proper formatting - Clean markdown with consistent link syntax

docs/llms-full.txt (Comprehensive guide):
Thorough documentation - Complete integration examples and use cases
Practical code examples - Real-world TypeScript examples throughout
Up-to-date information - Reflects current AI Gateway integration methods
Well-structured - Logical progression from basic to advanced topics

Technical Review:

No security issues - Pure documentation files with no executable code
No performance impact - Static text files
URL validation - Spot-checked key URLs and they're accessible
Content accuracy - Code examples match current Helicone integration patterns

Minor Enhancement Suggestions:

  1. Consider adding a note in llms.txt about the relationship between the two files:

    # Note: llms-full.txt contains comprehensive examples and detailed implementation guides
  2. File headers could clarify purpose:

    • llms.txt: "Quick reference and navigation index"
    • llms-full.txt: "Complete implementation guide with examples"

Conclusion:

This PR successfully addresses the issue described in ENG-3547. The llms.txt files will significantly help AI agents understand Helicone's current integration methods rather than generating legacy implementations. The content is accurate, comprehensive, and well-organized.

File placement is correct - both files should remain in the docs/ directory as currently positioned.


| Branch: add-llms.txt

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Dec 11, 2025

Greptile Overview

Greptile Summary

This PR adds llms.txt and llms-full.txt files to help AI agents better understand Helicone's documentation and integration methods.

Key changes:

  • Added docs/llms.txt: A concise index of documentation links organized by category (AI Gateway, Observability, Getting Started, Provider Integrations, etc.)
  • Added llms-full.txt: A comprehensive 1,478-line guide covering AI Gateway integration, sessions tracking, custom properties, user feedback, caching, provider routing, and prompt management with detailed code examples

Purpose: The PR addresses agents generating implementations based on legacy integration methods by providing up-to-date documentation in the llms.txt format that AI agents can consume.

Note: The llms-full.txt file is placed in the repository root rather than the docs directory. This may be intentional for certain deployment scenarios, but verify this placement matches the desired URL structure for the documentation site.

Confidence Score: 5/5

  • This PR is safe to merge - adds new documentation files with no code changes or risk of breaking existing functionality.
  • The PR only adds two new text files containing documentation. All URL references in llms.txt align with the existing docs structure. The content is well-written with accurate code examples matching the current Helicone integration patterns.
  • No files require special attention. Consider verifying llms-full.txt placement in root vs docs directory is intentional.

Important Files Changed

File Analysis

Filename Score Overview
docs/llms.txt 5/5 New llms.txt file providing AI agents with a concise overview of Helicone documentation and key integration links. Well-structured with correct URL references.
llms-full.txt 4/5 Comprehensive AI agent integration guide with detailed code examples for sessions, custom properties, caching, feedback, and provider routing. File is located in repo root instead of docs directory - verify this is intentional.

Sequence Diagram

sequenceDiagram
    participant Agent as AI Agent
    participant Docs as docs.helicone.ai
    participant LLMSTxt as llms.txt
    participant FullTxt as llms-full.txt
    
    Agent->>Docs: Request /llms.txt
    Docs-->>Agent: Return concise index
    Note over Agent: Get overview of<br/>documentation structure
    
    Agent->>Docs: Request /llms-full.txt
    Docs-->>Agent: Return comprehensive guide
    Note over Agent: Get detailed integration<br/>examples and code samples
    
    Agent->>Agent: Generate accurate<br/>Helicone implementation
Loading

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.

2 files reviewed, no comments

Edit Code Review Agent Settings | Greptile

@colegottdank
Copy link
Collaborator

llms-full.txt should be at the root?

@juliettech13
Copy link
Collaborator Author

llms-full.txt should be at the root?

good catch! updated - should be at root but of docs.

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.

2 participants