lukaszraczylo/traefik-llmgateway
1
0
Fork 0
mirror of https://github.com/lukaszraczylo/traefik-llmgateway.git synced 2026-10-18 05:47:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: render correctly on the Traefik plugin catalog

Browse Source 
The catalog uses a plain CommonMark renderer, not GitHub's: the
"[!WARNING]" alert syntax printed literally and the mermaid block
rendered as a wall of diagram source. Use a portable bold blockquote and
fold the diagram into <details> so plain renderers collapse it while
GitHub still draws it.
This commit is contained in:
lukaszraczylo
2026-08-22 11:21:40 +01:00
parent 1875ee7b8b
commit 2d10509e20
1 changed files with 7 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -2
View File
@@ -11,8 +11,8 @@ It runs as a [Yaegi](https://github.com/traefik/yaegi)-interpreted Go
module, the same way [`traefikoidc`](https://github.com/lukaszraczylo/traefikoidc) module, the same way [`traefikoidc`](https://github.com/lukaszraczylo/traefikoidc)
does, configured per-middleware in Traefik's dynamic configuration. does, configured per-middleware in Traefik's dynamic configuration.
> [!WARNING] > **⚠️ WARNING — experimental, proof of concept.**
> **Experimental — proof of concept.** Until version 1.0 this project is an > Until version 1.0 this project is an
> experiment in PoC development stage, not production ready. Configuration > experiment in PoC development stage, not production ready. Configuration
> keys, endpoints, and behaviour can change between pre-1.0 releases without > keys, endpoints, and behaviour can change between pre-1.0 releases without
> a deprecation period. Evaluate it, test it, break it — but do not put it > a deprecation period. Evaluate it, test it, break it — but do not put it
@@ -39,6 +39,9 @@ Catalog — see [Development](#development) for what that needs.
agents, so those can sit behind the same gateway, the same auth, and the agents, so those can sit behind the same gateway, the same auth, and the
same group-based visibility rules as the LLM traffic. same group-based visibility rules as the LLM traffic.
<details>
<summary><b>Request flow diagram</b> (mermaid — renders on GitHub)</summary>
```mermaid ```mermaid
flowchart LR flowchart LR
Req["incoming request"] --> Route{"route<br/>ServeHTTP: path+method dispatch"} Req["incoming request"] --> Route{"route<br/>ServeHTTP: path+method dispatch"}
@@ -74,6 +77,8 @@ flowchart LR
Registry --> Resp Registry --> Resp
``` ```
</details>
Every route the plugin recognises is handled entirely inside the Every route the plugin recognises is handled entirely inside the
middleware — `next` (the router's configured backing service) is only middleware — `next` (the router's configured backing service) is only
reached when a request matches none of the plugin's routes and reached when a request matches none of the plugin's routes and