Skip to content

Commit 75db328

Browse files
authored
llms.txt improvements (#110)
- Working on improving llms.txt integration with README.md and docs site - Created new llms.txt using Claude instead of from human documentation
1 parent 311c323 commit 75db328

5 files changed

Lines changed: 212 additions & 382 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,12 @@ gRPCClient.jl aims to be a production grade gRPC client emphasizing performance
1212
## Documentation
1313

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

17-
## Benchmarks
16+
### For LLMs & Agents
17+
18+
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.
1819

20+
## Benchmarks
1921

2022
### Naive Baseline: `julia`
2123

docs/make_llms.jl

Lines changed: 0 additions & 11 deletions
This file was deleted.

docs/make_llms.sh

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/src/index.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22

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

5-
A pure markdown version of this documentation is available here: [llms.txt](llms.txt)
6-
75
## Features
86

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

178176
These run forever, and are useful to help identify any stability issues or resource leaks.
177+
178+
## For LLMs & Agents
179+
180+
This library provides an [`llms.txt`](llms.txt) file designed to bootstrap your context with everything needed to use it effectively.
181+
182+
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.
183+
184+
**It contains:**
185+
- API surface and usage patterns
186+
- Key concepts and terminology
187+
- Common workflows and examples
188+
189+
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.

0 commit comments

Comments
 (0)