Files
kami 9734eec63c docs: add module documentation in AsciiDoc with PlantUML diagrams
Generated by per-group subagents covering all 52 modules across:
core (18), infrastructure (10), apps (5), interfaces (3),
plugins (7), testing (9)

Documentation format:
- AsciiDoc (.adoc) files in docs/modules/<group>/
- PlantUML (.puml) files in docs/diagrams/
- .adoc files reference diagrams via include:: directives

Each doc covers: purpose, responsibilities, non-responsibilities,
key types, event flow, integration points, invariants, PlantUML
diagram, known issues, and open questions.
2026-05-26 16:59:21 +04:00

55 lines
1.5 KiB
Plaintext

= app-desktop
== purpose
Placeholder application module for a future desktop GUI application. Currently contains only a stub `main()` function that prints its identity and exits.
== responsibilities
* Declares the module structure and build configuration for a future desktop application
* Prints a startup banner to stdout
== non-responsibilities
* Does not create any windows, UI components, or graphical interface
* Does not contain any domain logic or infrastructure wiring
* Does not connect to any Correx server
== key types
=== Main.kt
* **kind**: top-level `main()` function
* **purpose**: Placeholder entry point. Prints `"correx :: apps/desktop"` and exits.
== event flow
None. The module has no event interaction.
== integration points
* Depends only on `com.github.ajalt.clikt:clikt` in build configuration (no actual usage in source)
== invariants
* The module has no runtime state, invariants, or behavioral contracts beyond printing to stdout
== PlantUML diagram
[plantuml, app-desktop, "png"]
----
include::../../diagrams/app-desktop.puml[]
----
== known issues
* Not implemented — this is a structural placeholder with no functional code
== open questions
* Will the desktop app be built with Compose Multiplatform, JavaFX, or another UI toolkit?
* Should the desktop app embed the Correx server, or connect to an existing server instance?
* What is the relationship between desktop app and TUI — do they share components or are they independent implementations?