Add in-panel Help: CSS-only drawer with seeded Status and domain topics, «?» entry points on cards, and guide.md boundary for what stays in-repo. Co-authored-by: Cursor <cursoragent@cursor.com>
This commit is contained in:
@@ -311,6 +311,18 @@ Schedule `extract-cert.sh` (cron or a timer) alongside Traefik's renewals.
|
||||
After sign-in the panel opens on **Status** — the place to answer "is the
|
||||
service healthy and will mail be accepted?"
|
||||
|
||||
### In-panel help
|
||||
|
||||
The panel carries short operator notes so day-to-day work does not require
|
||||
opening this guide. **Help** in the navigation opens an index; each Status or
|
||||
domain card's «?» opens the same text in a side drawer (CSS only, no extra
|
||||
script). That content explains what a check or control *means* — kernel
|
||||
counters, TLS on port 465, forward-confirmed PTR, DNS publish hints, rate
|
||||
limits, and similar. It is not a second copy of this document: installation,
|
||||
reverse-proxy setup, backup/restore, environment variables, and security
|
||||
assumptions stay here in `docs/guide.md` (linked from the drawer and Help
|
||||
page).
|
||||
|
||||
### Status
|
||||
|
||||
`/status` shows supervised processes (Postfix, OpenDKIM, panel), TLS
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Plan: panel-docs (in-panel operator documentation)
|
||||
|
||||
**Status:** candidate
|
||||
**Status:** agreed
|
||||
**Date:** 2026-08-17
|
||||
**Version:** `1.x` MINOR; `candidate` until explicitly agreed.
|
||||
|
||||
@@ -46,9 +46,9 @@ Target version cut: **`1.8.0`** (MINOR). One commit per step; code only after
|
||||
roadmap status is **agreed**. See [development.md](../development.md) § Plan
|
||||
checklists.
|
||||
|
||||
- [ ] Help drawer / pages shell (CSS checkbox pattern from mockups) — **Sonnet**
|
||||
- [ ] Seed Status blurbs (Machine, TLS, PTR, …) — **Sonnet**
|
||||
- [ ] «?» entry points on domain cards — **Sonnet**
|
||||
- [ ] [guide.md](../guide.md) boundary: in-panel help vs full guide — **Sonnet**
|
||||
- [ ] Template tests — **Sonnet**
|
||||
- [ ] `go vet`, `go test` on touched packages — **Haiku**
|
||||
- [x] Help drawer / pages shell (CSS checkbox pattern from mockups) — **Sonnet**
|
||||
- [x] Seed Status blurbs (Machine, TLS, PTR, …) — **Sonnet**
|
||||
- [x] «?» entry points on domain cards — **Sonnet**
|
||||
- [x] [guide.md](../guide.md) boundary: in-panel help vs full guide — **Sonnet**
|
||||
- [x] Template tests — **Sonnet**
|
||||
- [x] `go vet`, `go test` on touched packages — **Haiku**
|
||||
|
||||
+1
-1
@@ -29,7 +29,7 @@ in `git log` and [CHANGELOG.md](../CHANGELOG.md).
|
||||
| ID | Topic | Status | Progress | Plan |
|
||||
|---|---|---|---|---|
|
||||
| contributing | `CONTRIBUTING.md` | candidate | — | — |
|
||||
| panel-docs | In-panel operator documentation | candidate | 0/6 | [plans/panel-docs.md](plans/panel-docs.md) |
|
||||
| panel-docs | In-panel operator documentation | agreed | 6/6 | [plans/panel-docs.md](plans/panel-docs.md) |
|
||||
| schema-squash | Squash SQLite migrations into a 2.x baseline | **2.x** | — | — |
|
||||
|
||||
**Recommended order** (not binding): the next feature is **panel-docs** once
|
||||
|
||||
Reference in New Issue
Block a user