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.
This commit is contained in:
@@ -0,0 +1,48 @@
|
||||
= interface-api
|
||||
|
||||
== purpose
|
||||
|
||||
No source files present. This directory is reserved for an API interface module that will define the public HTTP/REST contract exposed by Correx server applications. Currently a structural placeholder.
|
||||
|
||||
== responsibilities
|
||||
|
||||
* Declares the module structure for future API surface definitions
|
||||
|
||||
== non-responsibilities
|
||||
|
||||
* This module has no source code, types, or runtime behavior
|
||||
|
||||
== key types
|
||||
|
||||
*No types defined.*
|
||||
|
||||
== event flow
|
||||
|
||||
None. Module has no source files.
|
||||
|
||||
== integration points
|
||||
|
||||
* No current dependencies or dependents
|
||||
|
||||
== invariants
|
||||
|
||||
* Not applicable — module is empty
|
||||
|
||||
== PlantUML diagram
|
||||
|
||||
[plantuml, interface-api, "png"]
|
||||
----
|
||||
include::../../diagrams/interface-api.puml[]
|
||||
----
|
||||
|
||||
|
||||
|
||||
|
||||
== known issues
|
||||
|
||||
* This module contains no implementation — it is an empty placeholder
|
||||
|
||||
== open questions
|
||||
|
||||
* Will this module define OpenAPI specs, Ktor route contracts, or generated client stubs?
|
||||
* Should this module be removed and its purpose absorbed by `:apps:server`?
|
||||
Reference in New Issue
Block a user