From 77b102791f6374424dc5666205cf40a2d4588470 Mon Sep 17 00:00:00 2001 From: Hadi <112569860+anotherhadi@users.noreply.github.com> Date: Sat, 30 May 2026 00:14:35 +0200 Subject: [PATCH] edit docs Signed-off-by: Hadi <112569860+anotherhadi@users.noreply.github.com> --- docs/main.md | 1 + docs/plugins.md | 2 +- internal/ui/docs/model.go | 4 ++-- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/main.md b/docs/main.md index dfe7cd4..12c5d53 100644 --- a/docs/main.md +++ b/docs/main.md @@ -11,6 +11,7 @@ # Spilltea Documentation - **Version**: `{{.Cfg.Version}}` +- **Proxy**: `{{.Cfg.App.Host}}:{{.Cfg.App.Port}}` - **SSL Insecure**: `{{.Cfg.App.SslInsecure}}` - **Repository**: `https://github.com/anotherhadi/spilltea` - **Sponsor this project**: `https://ko-fi.com/anotherhadi` diff --git a/docs/plugins.md b/docs/plugins.md index bc35f63..d083da2 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -155,7 +155,7 @@ If the user **dismisses** a finding it is permanently hidden and will never reap ## Configuration -Plugin configuration is stored in a `plugins.yaml` file alongside the project database. +Plugin configuration is stored in a `plugins.yaml` file alongside the project database and can be edited through the "Proxy" TUI page. Each plugin is keyed by its filename (without the `.lua` extension) and has an `enable` toggle and an optional `config` block (arbitrary YAML). ```yaml diff --git a/internal/ui/docs/model.go b/internal/ui/docs/model.go index 1124231..34e4a91 100644 --- a/internal/ui/docs/model.go +++ b/internal/ui/docs/model.go @@ -25,10 +25,10 @@ func readDoc(name string) string { var contentMarkdown = strings.Join([]string{ readDoc("main.md"), - readDoc("legal-disclaimer.md"), - readDoc("basics.md"), readDoc("proxy.md"), readDoc("certificate.md"), + readDoc("legal-disclaimer.md"), + readDoc("basics.md"), readDoc("history.md"), }, "\n")