docs: unify documentation and streamline code comments
- Translated project documentation (LEARNING-JOURNEY, CONTRIBUTORS, AI_DISCLOSURE) to English for better accessibility. - Standardized internal code documentation by converting XML-doc blocks to standard comment format. - Cleaned up inline comments and removed redundant versioning metadata across the codebase. - Refactored non-functional text elements to improve readability and maintain a consistent style.
This commit is contained in:
+49
-53
@@ -1,87 +1,83 @@
|
||||
# Contributors — Hellion Chat
|
||||
|
||||
Hellion Chat ist von der Code-Seite ein Ein-Personen-Projekt. Aber ohne die Leute auf dieser Seite gäbe es weder die
|
||||
Bug-Fixes noch die UX-Verbesserungen, die seit den frühen Versionen reingelaufen sind. Jeder Eintrag hier hat das Plugin
|
||||
konkret besser gemacht.
|
||||
Hellion Chat is a one-person project on the code side. But without the people on this page, the bug fixes and UX
|
||||
improvements that have landed since the early versions would not exist. Every entry here has made the plugin concretely
|
||||
better.
|
||||
|
||||
Die Anerkennung an die Upstream-Autoren von Chat 2 (Infi und Anna) liegt bewusst in [`../NOTICE.md`](../NOTICE.md),
|
||||
nicht hier. Diese Datei deckt explizit Beiträge zur Hellion-Chat-Seite ab.
|
||||
Attribution for the upstream Chat 2 authors (Infi and Anna) is intentionally in [`../NOTICE.md`](../NOTICE.md), not
|
||||
here. This file covers contributions to the Hellion Chat side specifically.
|
||||
|
||||
---
|
||||
|
||||
## Entwicklung
|
||||
## Development
|
||||
|
||||
### JonKazama (Florian Wathling) — Maintainer
|
||||
|
||||
Hellion Chat ist mein erstes FFXIV-Plugin und mein erstes größeres C#-/Dalamud-Projekt. Mein beruflicher Hintergrund ist
|
||||
Webentwicklung (Next.js, React, TypeScript, Prisma). Plugin-Entwicklung in einer fremden Codebase, ImGui,
|
||||
FFXIV-Game-Hooks und der gesamte Dalamud-Stack waren Neuland.
|
||||
Hellion Chat is my first FFXIV plugin and my first larger C#/Dalamud project. My professional background is web
|
||||
development (Next.js, React, TypeScript, Prisma). Plugin development in an unfamiliar codebase, ImGui, FFXIV game hooks
|
||||
and the entire Dalamud stack were new territory.
|
||||
|
||||
Privacy-First-Defaults, Per-Channel-Retention, Auto-Tell-Tabs, Pop-Out-Input, ChatColours-Presets, Hellion-Theme plus
|
||||
Exo-2-Font und der v1.0.0-Standalone-Cut sind die Hellion-spezifischen Surface-Areas, die ich auf das Chat-2-Fundament
|
||||
aufgebaut habe. Die Lern-Geschichte dahinter steht in [`LEARNING-JOURNEY.md`](LEARNING-JOURNEY.md).
|
||||
Privacy-first defaults, per-channel retention, Auto-Tell-Tabs, pop-out input, ChatColours presets, the Hellion theme
|
||||
plus Exo 2 font, and the v1.0.0 standalone cut are the Hellion-specific surface areas I built on top of the Chat 2
|
||||
foundation. The learning story behind that is in [`LEARNING-JOURNEY.md`](LEARNING-JOURNEY.md).
|
||||
|
||||
Hellion Chat ist Teil von [Hellion Online Media](https://hellion-media.de).
|
||||
Hellion Chat is part of [Hellion Online Media](https://hellion-media.de).
|
||||
|
||||
---
|
||||
|
||||
## Tester
|
||||
## Testers
|
||||
|
||||
Eine kurze Notiz vorneweg: Ich teste das Plugin nicht allein. Die Leute hier haben mir Bugs gemeldet, bevor sie bei mehr
|
||||
Nutzern aufgeschlagen wären. Sie haben UX-Probleme angesprochen, die ich blind nicht mehr gesehen habe. Und sie haben
|
||||
Feature-Wünsche eingebracht, die das Plugin in Richtungen geschoben haben, in die ich von alleine nicht gegangen wäre.
|
||||
Das ist nicht selbstverständlich. Externe Tester sind ihre Zeit wert.
|
||||
A quick note: I do not test this plugin alone. The people listed here reported bugs before they hit more users, raised
|
||||
UX problems I had gone blind to, and brought in feature requests that pushed the plugin in directions I would not have
|
||||
gone on my own. That is not a given. External testers are worth their time.
|
||||
|
||||
### Carl Beleandis (Carla) — Beta-Tester
|
||||
### Carl Beleandis (Carla) — Beta Tester
|
||||
|
||||
Carl testet seit der Bootstrap-Phase und hat sowohl die Pop-Out-Mechanik als auch die Theme-Richtung geprägt. Sein
|
||||
Feedback kommt direkt und ohne Umschweife und das ist genau, was ich beim Testen brauche.
|
||||
Carl has been testing since the bootstrap phase and has shaped both the pop-out mechanics and the theme direction.
|
||||
Feedback comes direct and without detours, which is exactly what I need when testing.
|
||||
|
||||
Konkrete Beiträge:
|
||||
Concrete contributions:
|
||||
|
||||
- **Pop-Out-Discoverability** — der Hinweis, dass Pop-Outs nur per Rechtsklick erreichbar waren, hat den Header-Button
|
||||
und den einmaligen Hint-Banner in v0.6.1 ausgelöst. Ich kannte den Rechtsklick-Pfad blind, deshalb hatte ich nicht
|
||||
mehr gesehen, dass neue Nutzer die Funktion gar nicht finden.
|
||||
- **/tell-Pop-Out-Mode** — der Wunsch, /tell-Tabs direkt als Pop-Out zu öffnen statt über den Tab-Umweg, ist in v0.6.1
|
||||
als opt-in Settings-Toggle gelandet. Bonus: Bei der Implementation ist ein alter Ghost-Window-Bug aufgefallen
|
||||
(LRU-Drop ließ Pop-Out-Fenster als Geister stehen), der gleich mit gefixt wurde.
|
||||
- **Theme-Varianten mit Helligkeits-Abstufungen** — der Wunsch nach einer Grün-Familie hat mein Verständnis von "ein
|
||||
Theme = eine Farbe" auf "Theme-Familien mit Stimmungs-Varianten" verschoben. Steht in der [Roadmap](ROADMAP.md) für
|
||||
einen späteren Cycle.
|
||||
- **Pop-out discoverability** — pointing out that pop-outs were only reachable via right-click triggered the header
|
||||
button and the one-time hint banner in v0.6.1. I knew the right-click path by heart and had stopped seeing that new
|
||||
users could not find the feature at all.
|
||||
- **/tell pop-out mode** — the request to open /tell tabs directly as a pop-out instead of going through the tab sidebar
|
||||
landed in v0.6.1 as an opt-in settings toggle. Bonus: during implementation an old ghost-window bug surfaced (LRU drop
|
||||
left pop-out windows as ghosts), which got fixed at the same time.
|
||||
- **Theme variants with brightness gradations** — the request for a green family shifted my thinking from "one theme =
|
||||
one colour" to "theme families with mood variants". On the [roadmap](ROADMAP.md) for a later cycle.
|
||||
|
||||
### Jin (Jingliu) — Alpha-Tester
|
||||
### Jin (Jingliu) — Alpha Tester
|
||||
|
||||
Jin ist der aktive Tester der ersten Stunde und hat den Pop-Out-Workflow architektonisch in eine andere Richtung
|
||||
geschoben.
|
||||
Jin is the active tester from day one and pushed the pop-out workflow architecture in a different direction.
|
||||
|
||||
Konkrete Beiträge:
|
||||
Concrete contributions:
|
||||
|
||||
- **Pop-Out-Tab mit Input-Feld** — der Vorschlag, in einem Pop-Out auch tippen zu können (statt nur lesen), hat die
|
||||
v0.6.0 Pop-Out-Input-Bar ausgelöst. Das war ein größerer Refactor: Der Input-Layer aus `ChatLogWindow` musste so
|
||||
geöffnet werden, dass er auch in `Popout.cs` lebt, mit unabhängigem Text-Buffer und History-Cursor pro Pop-Out. Hat
|
||||
den Cycle dominiert, weil das Design erst sauber sein musste, bevor Code passieren konnte.
|
||||
- **TempTell Persistence** — der Wunsch, /tell-Tabs per Pin-Toggle einen Relog überleben zu lassen, steht in der
|
||||
[Roadmap](ROADMAP.md) für einen späteren Cycle. Berührt das Tab-System architektonisch und braucht eigenes Design.
|
||||
- **Pop-out tab with input bar** — the suggestion to be able to type in a pop-out (instead of just reading) triggered
|
||||
the v0.6.0 pop-out input bar. That was a larger refactor: the input layer from `ChatLogWindow` had to be opened up so
|
||||
it could also live in `Popout.cs`, with an independent text buffer and history cursor per pop-out. It dominated the
|
||||
cycle because the design had to be clean before any code could happen.
|
||||
- **TempTell persistence** — the request for /tell tabs to survive a relog via a pin toggle is on the
|
||||
[roadmap](ROADMAP.md) for a later cycle. It touches the tab system architecturally and needs its own design work.
|
||||
|
||||
---
|
||||
|
||||
## Übersetzungen
|
||||
## Translations
|
||||
|
||||
Hellion-eigene UI-Strings werden in `HellionChat/Resources/HellionStrings.<lang>.resx` gepflegt.
|
||||
Hellion-specific UI strings are maintained in `HellionChat/Resources/HellionStrings.<lang>.resx`.
|
||||
|
||||
- **Deutsch (DE):** JonKazama (Native Speaker, Hauptsprache des Projekts)
|
||||
- **German (DE):** JonKazama (native speaker, primary project language)
|
||||
|
||||
Die Upstream-Sprach-Dateien (`Language.<lang>.resx`) sind nicht Teil dieser Datei. Sie werden über das
|
||||
[Chat-2-Crowdin-Projekt](https://github.com/Infiziert90/ChatTwo) gepflegt; Crowdin-Übersetzer findest du in den
|
||||
Plugin-Settings unter **Info → "Chat 2 community translators"**.
|
||||
Upstream language files (`Language.<lang>.resx`) are not covered here. They are maintained via the
|
||||
[Chat 2 Crowdin project](https://github.com/Infiziert90/ChatTwo); Crowdin translators are listed in the plugin settings
|
||||
under **Info → "Chat 2 community translators"**.
|
||||
|
||||
---
|
||||
|
||||
## Wie du beitragen kannst
|
||||
## How to Contribute
|
||||
|
||||
Bug-Reports, Feature-Wünsche und Pull-Requests laufen über
|
||||
[Gitea Issues](https://gitea.hellion-forge.cloud/JonKazama-Hellion/HellionChat/issues). Workflow und Erwartungen stehen
|
||||
in [`../CONTRIBUTING.md`](../CONTRIBUTING.md), Code of Conduct in [`../CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md).
|
||||
Bug reports, feature requests and feedback are welcome — the best place to reach me is the Hellion Forge Discord:
|
||||
[discord.gg/X9V7Kcv5gR](https://discord.gg/X9V7Kcv5gR). Join and ping me in the Hellion Chat channel.
|
||||
|
||||
Tester-Pool für neue Versionen läuft über den Hellion-Forge-Discord:
|
||||
[discord.gg/X9V7Kcv5gR](https://discord.gg/X9V7Kcv5gR). Wer in den Tester-Channel rein will, einfach im Forge melden.
|
||||
For pull requests and contribution guidelines see [`../CONTRIBUTING.md`](../CONTRIBUTING.md), Code of Conduct in
|
||||
[`../CODE_OF_CONDUCT.md`](../CODE_OF_CONDUCT.md).
|
||||
|
||||
Reference in New Issue
Block a user