Skip to content

docs: Add scope legends to timpani system block diagrams#71

Merged
basheerFZ merged 1 commit into
eclipse-timpani:development_0.5from
LGSI-KarumuriHari:development_0.5
May 14, 2026
Merged

docs: Add scope legends to timpani system block diagrams#71
basheerFZ merged 1 commit into
eclipse-timpani:development_0.5from
LGSI-KarumuriHari:development_0.5

Conversation

@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor

📋 Description

Enhanced timpani-o and timpani-n system block diagrams in structure.md with visual scope legends and standardized color coding to clearly differentiate project components from external systems.

🎯 Changes Made

1. timpani-o System Block Diagram

  • Added Legend with 4 scope categories:

    • 🔵 timpani-o (Our Scope) - Blue (#e3f2fd)
    • 🟢 timpani-n Nodes (Our Scope) - Green (#e8f5e9)
    • 🟠 gRPC Communication (Our Scope) - Orange (#fff3e0)
    • ⚪ External Systems - Gray (#f5f5f5)
  • Updated Color Scheme:

    • All timpani-o components now use blue (#e3f2fd) with blue borders
    • timpani-n nodes use green (#e8f5e9) with green borders
    • gRPC Server and Fault Client use orange (#fff3e0) with orange borders
    • External systems (Piccolo, Admin) use gray (#f5f5f5)
    • Legacy D-Bus Server remains gray to indicate deprecated status

2. timpani-n System Block Diagram

  • Added Legend with 4 scope categories:

    • 🟢 timpani-n (Our Scope) - Green (#e8f5e9)
    • 🔵 timpani-o (Our Scope) - Blue (#e3f2fd)
    • 🟠 Communication (Our Scope) - Orange (#fff3e0)
    • ⚪ External Systems - Gray (#f5f5f5)
  • Updated Color Scheme:

    • All timpani-n internal components use green (#e8f5e9)
    • timpani-o reference uses blue (#e3f2fd)
    • Communication layer (TRPC, DBUS) uses orange (#fff3e0)
    • External systems (Kernel, Sample Apps) use gray (#f5f5f5)

3. Revision History

  • Updated to version 0.0c (2026-05-14)
  • Comment: "Added scope legends to timpani-o and timpani-n block diagrams"

✅ Verification

  • Mermaid syntax validated
  • Colors match standard scheme defined in HLD documents
  • Legends clearly show all scope categories
  • Revision history updated with new version
  • Document status remains "Draft"

🔗 Related

Relates to #28

Co-authored-by: Copilot <copilot@github.com>
@LGSI-KarumuriHari
Copy link
Copy Markdown
Contributor Author

@basheerFZ please review this pr. Thanks

Copy link
Copy Markdown
Contributor

@basheerFZ basheerFZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Accepted chnages done as per request

@basheerFZ basheerFZ merged commit 77dc331 into eclipse-timpani:development_0.5 May 14, 2026
6 checks passed
@basheerFZ basheerFZ added the documentation Improvements or additions to documentation label May 14, 2026
@github-project-automation github-project-automation Bot moved this from Backlog to Done in timpani Development May 14, 2026
@basheerFZ basheerFZ moved this from Done to In progress in timpani Development May 14, 2026
@basheerFZ basheerFZ moved this from Done to In progress in timpani Release May 14, 2026
@basheerFZ basheerFZ moved this from Done to In Progress in timpani feature requirements May 14, 2026
@basheerFZ basheerFZ added this to the Q1 (Milestone-1) milestone May 14, 2026
@basheerFZ basheerFZ moved this from In progress to Done in timpani Development May 14, 2026
@basheerFZ basheerFZ moved this from In progress to Done in timpani Release May 14, 2026
@basheerFZ basheerFZ moved this from In Progress to Done in timpani feature requirements May 14, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Done
Status: Done

Development

Successfully merging this pull request may close these issues.

2 participants