Add LLM friendly documentation (llms.txt) (#103)

- Add llms.txt to docs/src so its included in static documentation website.
- Also reference it in README.md
- Add build script using fork of Documenter.jl to generate markdown output for creation of llms.txt

Author: csvance

Project.toml

@@ -1,7 +1,7 @@
 name = "gRPCClient"
 uuid = "aaca4a50-36af-4a1d-b878-4c443f2061ad"
-authors = ["Carroll Vance <cs.vance@icloud.com>"]
 version = "1.0.0"
+authors = ["Carroll Vance <cs.vance@icloud.com>"]
 
 [deps]
 FileWatching = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee"
@@ -10,14 +10,14 @@ PrecompileTools = "aea7be01-6a6a-4083-8856-8a6e6704d82a"
 ProtoBuf = "3349acd9-ac6a-5e09-bcdb-63829b23a429"
 
 [compat]
-julia = "1.10"
 FileWatching = "^1.10"
 LibCURL = "~0.6.4, 1"
 PrecompileTools = "^1.2"
 ProtoBuf = "~1.2.1"
+julia = "1.10"
 
 [extras]
 Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
 
 [targets]
-test = ["Test"]
+test = ["Test"]

README.md

@@ -12,6 +12,7 @@ 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 `docs/src/llms.txt`.
 
 ## Benchmarks
 

docs/make_llms.jl

@@ -0,0 +1,11 @@
+using Documenter
+using gRPCClient
+
+makedocs(
+    sitename = "gRPCClient.jl",
+    # NOTE: This is not implemented in upstream Documenter.jl
+    # I maintain my own fork that I use in order to produce Markdown output
+    # https://github.com/csvance/Documenter.jl/tree/markdown-output
+    format = Documenter.MarkdownDoc(),
+    modules = [gRPCClient]
+)

docs/make_llms.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+julia --project=docs << EOF
+using Pkg
+Pkg.add(url="https://github.com/csvance/Documenter.jl", rev="markdown-output")
+Pkg.develop(path=".")
+EOF
+
+julia --project=docs docs/make_llms.jl
+cp docs/build/index.md docs/src/llms.txt
+
+julia --project=docs << EOF
+using Pkg
+Pkg.add("Documenter")
+Pkg.rm("gRPCClient")
+EOF