From 6647ff448e0cd150318fd25ef68636cd9ffbd751 Mon Sep 17 00:00:00 2001 From: yusing Date: Fri, 9 Jan 2026 10:27:55 +0800 Subject: [PATCH] docs: enhance package README documentation --- internal/autocert/README.md | 9 +++++++++ internal/entrypoint/README.md | 2 +- internal/homepage/widgets/README.md | 2 +- 3 files changed, 11 insertions(+), 2 deletions(-) diff --git a/internal/autocert/README.md b/internal/autocert/README.md index 0c50f456..496e2e76 100644 --- a/internal/autocert/README.md +++ b/internal/autocert/README.md @@ -144,6 +144,11 @@ flowchart TD T --> V[Update SNI Matcher] V --> G + + style E fill:#22553F,color:#fff + style I fill:#8B8000,color:#fff + style N fill:#22553F,color:#fff + style U fill:#84261A,color:#fff ``` ### SNI Matching Flow @@ -163,6 +168,10 @@ flowchart LR F -->|Yes| D F -->|No| G[Return default cert] end + + style C fill:#27632A,color:#fff + style E fill:#18597A,color:#fff + style F fill:#836C03,color:#fff ``` ### Suffix Tree Structure diff --git a/internal/entrypoint/README.md b/internal/entrypoint/README.md index bef905a1..2f9b256b 100644 --- a/internal/entrypoint/README.md +++ b/internal/entrypoint/README.md @@ -9,7 +9,7 @@ The entrypoint package implements the primary HTTP handler that receives all inc ### Key Features - Domain-based route lookup with subdomain support -- Short link (`go/` domain) handling +- Short link (`go/` domain) handling - Middleware chain application - Access logging for all requests - Configurable not-found handling diff --git a/internal/homepage/widgets/README.md b/internal/homepage/widgets/README.md index c5aefa39..c52d62d6 100644 --- a/internal/homepage/widgets/README.md +++ b/internal/homepage/widgets/README.md @@ -109,7 +109,7 @@ var HTTPClient = &http.Client{ ### Available Providers -- **qbittorrent** - qBittorrent torrent client integration (WIP) +- **qbittorrent** - qBittorrent torrent client integration _(WIP)_ ## Usage Example