docs: add runtime architecture diagram to RHDH Local guide

[Fortune-Ndlovu]

Summary

• Adds a service flow architecture diagram (rhdh-local-runtime-architecture.png) to docs/images/
• Embeds the diagram in the RHDH Local guide index page (docs/rhdh-local-guide/index.md) under a new "Architecture Overview" section, placed between the use cases and the key requirements

Signed-off-by: fndlovu@redhat.com

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[rhdh-qodo-merge]

PR Summary by Qodo

Docs: add runtime architecture diagram to RHDH Local guide
📝 Documentation 🕐 Less than 10 minutes

Description

• Add an “Architecture Overview” section to the RHDH Local guide landing page.
• Embed a runtime service-flow diagram image at a fixed display width.
• Provide readers a quick visual model of services, scripts, volumes, and env wiring.

Diagram

graph TD
  A["Docs author"] --> B["docs/rhdh-local-guide/index.md"] --> D["MkDocs build"] --> E["Rendered site"] --> F["Reader"]
  B --> C["docs/images/rhdh-local-runtime-architecture.png"] --> D

Loading

High-Level Assessment

The following are alternative approaches to this PR:

1. Inline Mermaid diagram in Markdown

• ➕ Diff-friendly and easy to review/iterate in PRs
• ➕ No binary asset; keeps diagram close to the narrative
• ➖ Requires Mermaid support/config in the MkDocs pipeline/theme
• ➖ Harder to match complex visual styling vs design tools

2. Use SVG (and commit the editable source)

• ➕ Scales crisply at any DPI; often smaller than PNG
• ➕ Source-controlled edits (e.g., draw.io/figma export) improve maintainability
• ➖ Still adds an asset pipeline/authoring expectation
• ➖ SVG sanitization/review may be required depending on publishing constraints

Recommendation: The current PNG embed is a pragmatic improvement and is fine to merge. If this diagram is expected to evolve, consider also committing the diagram’s editable source (or switching to SVG/Mermaid) to make future updates reviewable and reduce binary-only changes.

Files changed (2) +6 / -0

Documentation (2) +6 / -0

index.mdAdd Architecture Overview section with embedded diagram +6/-0

Add Architecture Overview section with embedded diagram

• Introduces a new “Architecture Overview” section between the use cases and key requirements. Embeds the runtime service-flow diagram with a fixed width attribute for consistent rendering.

docs/rhdh-local-guide/index.md

rhdh-local-runtime-architecture.pngAdd runtime architecture diagram image asset +0/-0

Add runtime architecture diagram image asset

• Adds a new diagram image under docs/images for use in the RHDH Local guide landing page.

docs/images/rhdh-local-runtime-architecture.png

[rhdh-qodo-merge]

Code Review by Qodo

🐞 Bugs (1) 📘 Rule violations (0) 📜 Skill insights (0)

1. Ambiguous compose command 🐞 Bug ⚙ Maintainability

Description

In docs/rhdh-local-guide/index.md, the new Architecture Overview text says to run compose up,
which is underspecified (no docker/podman) and inconsistent with the rest of the guide’s command
style. This can confuse readers about the exact command to run when following the documentation.

Code

docs/rhdh-local-guide/index.md[62]

+The following diagram illustrates the RHDH Local service flow, showing how the container services, entry scripts, shared volumes, and environment configuration fit together when you run `compose up`.

Relevance

⭐⭐⭐ High

Docs reviews enforce explicit Podman/Docker compose commands and parity; ambiguity fixes accepted
repeatedly (e.g. PRs #153, #147).

PR-#153
PR-#147
PR-#239

ⓘ Recommendations generated based on similar findings in past PRs

Evidence

The new text introduces a generic compose up reference, while other RHDH Local guide pages
consistently specify podman compose up -d / docker compose up -d (or use `[docker|podman]
compose up`) to avoid ambiguity.

docs/rhdh-local-guide/index.md[60-64]
docs/rhdh-local-guide/getting-started.md[44-54]
docs/rhdh-local-guide/dynamic-plugins-management.md[91-94]

Agent prompt

The issue below was found during a code review. Follow the provided context and guidance below and implement a solution

## Issue description
The new Architecture Overview section references running `compose up` without specifying whether users should run `docker compose ...` or `podman compose ...`, which is inconsistent with other pages in the RHDH Local guide.

## Issue Context
Other guide pages consistently spell this out as `podman compose up -d` / `docker compose up -d` or use `[docker|podman] compose up` when discussing behavior generically.

## Fix Focus Areas
- docs/rhdh-local-guide/index.md[60-64]

### Suggested change
Update the sentence to match the established pattern, e.g.:
- "...when you run `[docker|podman] compose up -d`." or
- "...when you run `podman compose up -d` (or `docker compose up -d`)."

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

---

[rm3l]

Thanks for adding this! Having a diagram like this is valuable.
However, I can see that this is already outdated as it doesn't include the Lightspeed containers (which are now enabled by default).
And in general, a .png diagram is opaque to diffs and will likely go stale as the project evolves. I'd suggest switching to a text-based diagram that could be rendered as expected by TechDocs (Mermaid, PlantUML, ...), if possible.