chore: streamline compatibility tracking and documentation

2026-10-09 11:43:02 +08:00
1 parent 92d2ba9889
commit 23f0456622
@@ -1,10 +1,10 @@
 # Gitea Mail Templates

-A curated collection of professionally designed, audience-driven email templates for self-hosted [Gitea](https://about.gitea.com) instances.
+Polished, drop-in email template themes for self-hosted [Gitea](https://about.gitea.com).

-[![Gitea](https://img.shields.io/badge/Gitea-28.0.0%20%7C%2028.0.0%20tested-blue)](COMPATIBILITY.md) <!-- TRACKER:BADGE -->
+[![Gitea](https://img.shields.io/badge/Gitea-28.1.0%20%5BPENDING%5D%20%7C%2028.0.0%20tested-yellow)](COMPATIBILITY.md) <!-- TRACKER:BADGE -->

-> **Release v28.0.0 — verified with Gitea 28.0.0 — 110 template files, 10 visual styles, 11 email types each.**
+> Latest Release: [v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0)

 ---

@@ -31,9 +31,9 @@ The templates on `main` can replace Gitea's built-in mail templates without patc
 | ![Ink](docs/images/ink.png) | **Ink** | Publishing / News / Literature | Editorial print, navy & gold, newspaper layout, drop caps |
 | ![Aurora](docs/images/aurora.png) | **Aurora** | Premium SaaS / Mindfulness | Ethereal light gradients, deep purple & teal, atmospheric glow |

-> Images are screenshots from the [live preview](preview/index.html). See [docs/images/README.md](docs/images/README.md) for capture instructions.
+> Images are screenshots from the [local preview](preview/index.html). See [docs/images/README.md](docs/images/README.md) for capture instructions.

-[**Live preview gallery**](preview/index.html) — open in a browser for an interactive style switcher with desktop/mobile viewports and view mode (Modern, Source).
+[**Local preview gallery**](preview/index.html) — generate the preview data as described below, then open it in a browser for an interactive style switcher with desktop/mobile viewports and view mode (Modern, Source).

 ---

@@ -82,15 +82,17 @@ reset email — it will render with your custom styles.

 ## Preview

-Two modes are available — a zero-dependency static preview for quick checks, and a live-reload dev server for design work.
+Two modes are available — a static preview that needs no server after generation, and a live-reload dev server for design work. A source clone must generate preview data first. Existing v28.0.0 and earlier archives do not contain the preview or gallery screenshots; the updated packaging workflow includes both for future builds.

 ### Static Preview

-Generate the preview data once (Go only), then open in a browser:
+From a source clone, generate the preview data once, then open the HTML file in a browser:

 ```bash
-cd tools && go run . preview all
-open preview/index.html        # no server needed
+cd tools
+go run . preview all
+cd ..
+# Open preview/index.html in a browser; no server is needed.
 ```

 ### Dev Server (Live Reload)
@@ -98,15 +100,16 @@ open preview/index.html        # no server needed
 Start a pure Go development server that watches for `.tmpl` changes, auto-rebuilds, and pushes live updates to the browser via SSE:

 ```bash
-cd tools && go run . dev
-open http://localhost:3456
+cd tools
+go run . dev
+# Open http://localhost:3456 in a browser.
 ```

 | Capability | Static | Dev |
 |-----------|--------|-----|
-| Go template rendering | ✅ | ✅ |
-| Theme/template switching | ✅ | ✅ |
-| Live reload on save | — | ✅ |
+| Go template rendering | [YES] | [YES] |
+| Theme/template switching | [YES] | [YES] |
+| Live reload on save | [NO] | [YES] |

 ### Features

@@ -127,7 +130,7 @@ gitea-mail-templates/
 │   ├── ...               # Custom styles are added here as separate directories
 ├── preview/              # Live preview SPA
 │   ├── index.html        # Style/template/client/viewport switcher
-│   └── rendered.js       # Pre-rendered templates (generated by tools/)
+│   └── rendered.js       # Generated by tools/; ignored in source clones
 ├── tools/                # Modular CLI tooling
 │   ├── tools.go          #   Main entry point
 │   ├── cli/              #   CLI subcommands (list, create, delete, preview)
@@ -165,7 +168,8 @@ gitea-mail-templates/

 - **Gitea 28.0.0** — use template release v28.0.0; earlier Gitea versions require an older package
 - **Latest tested:** Gitea 28.0.0 <!-- TRACKER:LATEST-TESTED -->
- **Latest release:** [v28.0.0](https://github.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0) updates all 10 release-notification templates for Gitea's `FormatByteSize` function. Use [v1.27.3](https://github.com/KenanZhu/GiteaMailTemplates/releases/tag/v1.27.3) for Gitea 1.25.0–1.27.3 (see [COMPATIBILITY.md](COMPATIBILITY.md))
+- **Latest release:** [v28.0.0](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v28.0.0) updates all 10 release-notification templates for Gitea's `FormatByteSize` function. Use [v1.27.3](https://gitea.kenanzhu.com/KenanZhu/GiteaMailTemplates/releases/tag/v1.27.3) for Gitea 1.25.0–1.27.3 (see [COMPATIBILITY.md](COMPATIBILITY.md))
+- **Upstream Gitea 28.1.0:** [PENDING] <!-- TRACKER:UPSTREAM -->
 - The current source uses Gitea's official template data paths — see [COMPATIBILITY.md](COMPATIBILITY.md) for release-specific limitations
 - Uses only built-in Gitea template functions and official translation keys
 - No custom template functions or locale patches required
@@ -178,7 +182,7 @@ gitea-mail-templates/
 2. **Accessible** — 4.5:1 contrast ratios; semantic HTML
 3. **Graceful degradation** — Fallback link visible when buttons fail to render
 4. **Logo support** — References `{{AppUrl}}assets/img/favicon.png` by default
-5. **i18n-ready** — All user-facing strings use Gitea's `{{.locale.Tr}}` system
+5. **Locale-aware** — Notification text uses Gitea's `{{.locale.Tr}}` system; some decorative labels remain theme-specific English text

 ---