Skip to content

Update documentation to make it clear where to find llms.txt #109

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 23, 2026
Merged

Update documentation to make it clear where to find llms.txt #109

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
2 changes: 2 additions & 0 deletions docs/src/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

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
26 changes: 14 additions & 12 deletions docs/src/llms.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

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 @@ -79,7 +81,7 @@ client = TestService_TestRPC_Client("172.238.177.88", 8001; grpc=grpc_myapp)
grpc_shutdown(grpc_myapp)
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/gRPC.jl#L10-L28)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/gRPC.jl#L10-L28)

```
gRPCClient.grpc_shutdown — Method.
Expand All @@ -93,7 +95,7 @@ Shuts down the `gRPCCURL`. This neatly cleans up all active connections and requ
development with Revise. Unless specifying the `gRPCCURL`, the global one provided by `grpc_global_handle()` is
shutdown.

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/gRPC.jl#L32-L36)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/gRPC.jl#L32-L36)

```
gRPCClient.grpc_global_handle — Method.
Expand All @@ -106,7 +108,7 @@ grpc_global_handle()
Returns the global `gRPCCURL` state which contains a libCURL multi handle. By default all gRPC clients use this multi in
order to ensure that HTTP/2 multiplexing happens where possible.

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/gRPC.jl#L3-L7)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/gRPC.jl#L3-L7)

### Generated ServiceClient Constructors

Expand Down Expand Up @@ -199,7 +201,7 @@ for request in requests
end
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Unary.jl#L3-L31)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Unary.jl#L3-L31)

```
gRPCClient.grpc_async_request — Method.
Expand Down Expand Up @@ -239,7 +241,7 @@ for i in 1:N
end
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Unary.jl#L70-L101)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Unary.jl#L70-L101)

```
gRPCClient.grpc_async_await — Method.
Expand All @@ -252,7 +254,7 @@ grpc_async_await(client::gRPCServiceClient{TRequest,false,TResponse,false}, requ
Wait for the request to complete and return the response when it is ready. Throws any exceptions that were encountered
during handling of the request.

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Unary.jl#L145-L149)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Unary.jl#L145-L149)

```
gRPCClient.grpc_sync_request — Method.
Expand Down Expand Up @@ -280,7 +282,7 @@ response = grpc_sync_request(client, TestRequest(1, zeros(UInt64, 1)))
@info response
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Unary.jl#L156-L176)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Unary.jl#L156-L176)

#### Streaming

Expand Down Expand Up @@ -318,7 +320,7 @@ close(request_c)
test_response = grpc_async_await(client, req)
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Streaming.jl#L110-L138)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Streaming.jl#L110-L138)

```
gRPCClient.grpc_async_request — Method.
Expand Down Expand Up @@ -354,7 +356,7 @@ end
grpc_async_await(req)
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Streaming.jl#L167-L195)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Streaming.jl#L167-L195)

```
gRPCClient.grpc_async_request — Method.
Expand Down Expand Up @@ -396,7 +398,7 @@ close(request_c)
grpc_async_await(req)
```

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Streaming.jl#L231-L265)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Streaming.jl#L231-L265)

```
gRPCClient.grpc_async_await — Method.
Expand All @@ -408,7 +410,7 @@ grpc_async_await(client::gRPCServiceClient{TRequest,true,TResponse,false},reques

Raise any exceptions encountered during the streaming request.

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/Streaming.jl#L299-L303)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/Streaming.jl#L299-L303)

### Exceptions

Expand All @@ -424,7 +426,7 @@ This exception type has two fields:
1. `grpc_status::Int` - See [here](https://grpc.io/docs/guides/status-codes/) for an indepth explanation of each status.
2. `message::String`

[source](https://github.com/JuliaIO/gRPCClient.jl/blob/2e39c9c699b979f81dd966129119e56afba0c3aa/src/gRPCClient.jl#L21-L29)
[source](https://github.com/JuliaIO/gRPCClient.jl/blob/bd65a3307e1bc0b293675203946d887fab25e5b6/src/gRPCClient.jl#L21-L29)

## gRPCClientUtils.jl

Expand Down