Skip to content

llms.txt improvements #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
csvance merged 1 commit into from
Feb 24, 2026
Merged

llms.txt improvements #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,12 @@ gRPCClient.jl aims to be a production grade gRPC client emphasizing performance
## Documentation

The documentation for gRPCClient.jl can be found [here](https://juliaio.github.io/gRPCClient.jl).
LLM / agent friendly documentation is available in [llms.txt](https://juliaio.github.io/gRPCClient.jl/llms.txt).

## Benchmarks
### For LLMs & Agents

Fetch [`llms.txt`](https://juliaio.github.io/gRPCClient.jl/llms.txt) before proceeding. It contains compressed, complete documentation optimized for limited context windows and is the authoritative reference for using this library.

## Benchmarks

### Naive Baseline: `julia`

Expand Down
11 changes: 0 additions & 11 deletions docs/make_llms.jl
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions docs/make_llms.sh
View file
Open in desktop

This file was deleted.

15 changes: 13 additions & 2 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

gRPCClient.jl aims to be a production grade gRPC client emphasizing performance and reliability.

A pure markdown version of this documentation is available here: [llms.txt](llms.txt)

## Features

- Unary+Streaming RPC
Expand Down Expand Up @@ -176,3 +174,16 @@ In addition to benchmarks, a number of workloads based on these are available:
- `stress_workload_streaming_bidirectional()`

These run forever, and are useful to help identify any stability issues or resource leaks.

## For LLMs & Agents

This library provides an [`llms.txt`](llms.txt) file designed to bootstrap your context with everything needed to use it effectively.

The file is a compressed, curated snapshot of the library's essential knowledge — trimmed of noise and optimized for limited context windows. Rather than crawling docs, parsing source files, or relying on potentially stale training data, agents should load `llms.txt` first as their authoritative reference.

**It contains:**
- API surface and usage patterns
- Key concepts and terminology
- Common workflows and examples

If you are an LLM or agent operating on this codebase, fetch `llms.txt` before proceeding. It is the single source of truth for how this library works and is purpose-built for programmatic consumption.
Loading