Skip to content

docs(diagrams): add deployment diagram type standard, template and IT-topology reference #132

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cuioss-oliver merged 6 commits into from
Jul 30, 2026
Merged

docs(diagrams): add deployment diagram type standard, template and IT-topology reference #132

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
734b70a
chore(architecture): refresh cached skills_by_profile enrichment
cuioss-oliver Jul 29, 2026
b2d59a8
docs(diagrams): add deployment diagram type standard, template and IT…
cuioss-oliver Jul 29, 2026
a930835
docs(diagrams): fix three internal inconsistencies in the deployment …
cuioss-oliver Jul 30, 2026
1557112
docs(diagrams): use ladder-neutral wording for the innermost radius row
cuioss-oliver Jul 30, 2026
06979ae
chore(finalize): apply finalize-step-preference-emitter changes
cuioss-oliver Jul 30, 2026
9865794
docs(diagrams): justify the depth-4 nesting floor by legibility, not …
cuioss-oliver Jul 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions .plan/project-architecture/api-sheriff-parent/enriched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,11 @@
"description": "Core Java patterns including modern features and performance optimization",
"skill": "pm-dev-java:java-core"
},
"pm-dev-java-cui:cui-logging"
"pm-dev-java-cui:cui-logging",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 build-dispatch routes builds through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"module_testing": {
Expand All @@ -59,7 +63,11 @@
"description": "JUnit 5 testing patterns with AAA structure, coverage analysis, and assertion standards",
"skill": "pm-dev-java:junit-core"
},
"pm-dev-java-cui:cui-logging"
"pm-dev-java-cui:cui-logging",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 test-run dispatch routes through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"quality": {
Expand Down
12 changes: 10 additions & 2 deletions .plan/project-architecture/api-sheriff/enriched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,11 @@
"skill": "pm-dev-java:java-maintenance"
},
"pm-dev-java-cui:cui-logging",
"pm-dev-java-cui:cui-http"
"pm-dev-java-cui:cui-http",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 build-dispatch routes builds through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"module_testing": {
Expand Down Expand Up @@ -116,7 +120,11 @@
},
"pm-dev-java-cui:cui-logging",
"pm-dev-java-cui:cui-testing",
"pm-dev-java-cui:cui-http-testing"
"pm-dev-java-cui:cui-http-testing",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 test-run dispatch routes through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"quality": {
Expand Down
12 changes: 10 additions & 2 deletions .plan/project-architecture/benchmarks/enriched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@
"description": "Core Java patterns including modern features and performance optimization",
"skill": "pm-dev-java:java-core"
},
"pm-dev-java-cui:cui-logging"
"pm-dev-java-cui:cui-logging",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 build-dispatch routes builds through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"module_testing": {
Expand All @@ -58,7 +62,11 @@
"description": "JUnit 5 testing patterns with AAA structure, coverage analysis, and assertion standards",
"skill": "pm-dev-java:junit-core"
},
"pm-dev-java-cui:cui-logging"
"pm-dev-java-cui:cui-logging",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 test-run dispatch routes through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"quality": {
Expand Down
24 changes: 23 additions & 1 deletion .plan/project-architecture/documentation/enriched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
{
"best_practices": [],
"best_practices": [
"When an automated review suggestion contradicts a decision this plan already audited and recorded, decline the suggestion and cite the audit rather than reversing it. Documentation standards in this repo carry deliberate, recorded choices (format outliers kept for upstream-graft portability, verification obligations deliberately left local rather than CI-gated); a reviewer seeing only the file will read those as defects. Treat re-litigation of a settled decision as a standing consideration, not a finding."
],
"insights": [],
"internal_dependencies": [],
"key_dependencies": [],
Expand Down Expand Up @@ -37,6 +39,26 @@
"skill": "pm-documents:manage-interface"
}
]
},
"implementation": {
"defaults": [
{
"description": "AsciiDoc formatting, validation, link verification, and template creation",
"skill": "pm-documents:ref-asciidoc"
},
{
"description": "Content quality, tone analysis, organization standards, and review orchestration",
"skill": "pm-documents:ref-documentation"
},
{
"description": "Narrative styles for technical documentation \u2014 tone, voice, and arc for the engineering-narrative style",
"skill": "pm-documents:ref-narrative-styles"
},
{
"description": "SVG diagram authoring standards \u2014 visual language, theme handling, AsciiDoc embedding, per-diagram-type patterns",
"skill": "pm-documents:ref-svg-diagrams"
}
]
}
},
"skills_by_profile_reasoning": "documentation: AsciiDoc design docs under doc/ incl. 4 ADRs (manage-adr optional applies)",
Expand Down
12 changes: 10 additions & 2 deletions .plan/project-architecture/integration-tests/enriched.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@
"skill": "pm-dev-java:java-maintenance"
},
"pm-dev-java-cui:cui-logging",
"pm-dev-java-cui:cui-http"
"pm-dev-java-cui:cui-http",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 build-dispatch routes builds through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
]
},
"module_testing": {
Expand Down Expand Up @@ -103,7 +107,11 @@
},
"pm-dev-java-cui:cui-logging",
"pm-dev-java-cui:cui-testing",
"pm-dev-java-cui:cui-http-testing"
"pm-dev-java-cui:cui-http-testing",
{
"description": "marshalld build-server consumption client (submit/wait/ping/preflight) \u2014 test-run dispatch routes through the daemon when the project is registered, else falls back in-process",
"skill": "plan-marshall:build-server-client"
}
]
},
"quality": {
Expand Down
12 changes: 12 additions & 0 deletions doc/development/README.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,18 @@ This tree is seeded here and grows as contributor-facing material lands.
change requires a `FORMAT_VERSION` bump, the derived session identity with its
stability-and-uniqueness constraints, the engine-boundary rule, and the unit/integration test
entry points.

| link:integration-test-topology.adoc[Integration-Test Topology]
| The shape of the stack `integration-tests` brings up -- the five gateway instances and their
published ports, the SNI front listener's L4 relay to the passthrough backend, the mounted
certificate and configuration material, and the two trust boundaries -- drawn from
`docker-compose.yml` and the mounted `gateway.yaml`, which stay the authoritative sources.

| link:diagram-type-deployment.md[Deployment Diagram Type -- Authoring Standard]
| How a deployment/topology SVG is drawn -- containment nesting with its depth limit and insets,
protocol-and-port edge labels, the trust-boundary visual that stays inside the theme-neutral
palette, first-party vs external components, mounted material, and the container-run render
check. Written in Markdown, deliberately, so it can graduate upstream unchanged.
|===

== Scope of This Layer
Expand Down
Loading
Loading