docs: hold the documentation against the code

Every claim in the user-facing docs, checked against what the plugin
actually does after A2 to A5.

The two GDPR sections in PRIVACY.md describe features that only exist
again as of this cycle, so they now name the screens they live on and
say what the cleanup does with a channel this build does not recognise.
The export sentence promised a date range; the form offers an age in
days.

PRIVACY.md also named "Show emotes" in Settings as the way to stop the
one outbound call the plugin makes. That switch has had no control since
May, and a documented opt-out that only exists in the JSON is not an
opt-out, so the toggle is back in the chat tab. Both its strings were
already translated.

Dead paths: the README source tree still listed a file deleted in May,
docs/IPC.md cited a window that no longer exists, the first-run wizard
pointed at the same removed file, and the theme authoring guide sent
readers to a Themes tab that is called Appearance.

The changelog lost two double blank lines that were failing markdownlint
and holding preflight red. Preflight is green again.

Historical documents keep their old paths on purpose: the changelog and
the AI disclosure describe what was true when they were written.
This commit is contained in:
2026-08-18 21:51:15 +02:00
parent e24ea79302
commit 1987d745d8
7 changed files with 41 additions and 19 deletions
-2
View File
@@ -130,7 +130,6 @@ release stays at v1.5.6.
- Test suite 829 → 892, and `StatusBarCacheTests` is back in the build after sitting in the
exclusion block.
## [1.9.0] — unreleased (local only)
Polish, tester-beta preparation and a concurrency hardening pass. **Not published** — the public
@@ -164,7 +163,6 @@ the assembly version reads 1.9.0.
- Removed `DeferredSaveFrames`: the debounce was fully wired but never armed.
- Test suite 812 → 829, including migration and query-plan coverage.
## Hellion Chat 1.5.6 — Settings Overhaul + Filter & Notification Polish (2026-05-23)
- Settings window reorganised: ten tabs down to seven (General, Appearance, Chat, Window, Channels, Data & Privacy, About). Each tab now uses collapsible sections grouped by control type. Sections start collapsed every time you open a tab — less noise, easier to find what you need.
+2 -2
View File
@@ -169,8 +169,8 @@ the same tuple:
`ChannelType` is the `HellionChat.Code.ChatType` enum value representing the target channel for the
current submission. It is sourced from the active tab's `UsedChannel`
(`HellionChat/Configuration.cs`), which the plugin keeps in sync by hooking the in-game shell
(`HellionChat/GameFunctions/Chat.cs`) and by resolving temporary overrides inside the chat UI
(`HellionChat/Ui/ChatLogWindow.cs:597`). `InputChannel` values are converted into the exported
(`HellionChat/GameFunctions/Chat.cs`) and by resolving temporary overrides in the input bar
(`HellionChat/Ui/Components/InputBar.cs`). `InputChannel` values are converted into the exported
`ChatType` via `HellionChat/Code/InputChannelExt.ToChatType`.
### Behavior
+5 -5
View File
@@ -10,11 +10,11 @@
## TL;DR
1. Open Settings → Themes → **Open themes folder**
1. Open Settings → Appearance → **Open themes folder**
2. Copy `example-theme.json` to `<your-name>.json` in the same folder
3. Edit the file with any text editor
4. Reload the plugin (toggle off/on in `/xlplugins`)
5. Your theme appears in the Custom-Themes section in Settings → Themes
5. Your theme appears in the Custom-Themes section in Settings → Appearance
That's the whole loop. The rest of this document is reference.
@@ -24,7 +24,7 @@ That's the whole loop. The rest of this document is reference.
%APPDATA%\XIVLauncher\pluginConfigs\HellionChat\themes\
```
(or the equivalent path on Linux/macOS — Settings → Themes → "Open themes folder" opens it
(or the equivalent path on Linux/macOS — Settings → Appearance → "Open themes folder" opens it
directly).
Each `*.json` file in this folder is loaded as one theme. The `example-theme.json` that HellionChat
@@ -179,11 +179,11 @@ Check `/xllog` after a plugin reload to see what loaded and what didn't.
1. Edit the JSON, save the file.
2. Reload the plugin: `/xlplugins` → toggle HellionChat off, then on.
3. Settings → Themes → click your theme card.
3. Settings → Appearance → click your theme card.
4. Watch every plugin window (chat, settings, pop-out) and pick something to fix.
5. Tweak. Reload. Repeat.
Tip: the **Settings → Themes** picker shows a mini-mockup per theme — your colors are visible before
Tip: the **Settings → Appearance** picker shows a mini-mockup per theme — your colors are visible before
you switch.
## Sharing themes