diff --git a/doc/README.md b/doc/README.md index 8ad7c21..e1b96b4 100644 --- a/doc/README.md +++ b/doc/README.md @@ -5,6 +5,22 @@ # timpani Documentation Guide +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-doc-index +- **Document Status:** Published +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | 2026-05-13 | Initial documentation guide | Eclipse timpani Team | - | + +--- + **Last Updated:** May 12, 2026 **Project:** Eclipse timpani (Rust Migration) **Version:** Milestone 1 & 2 (gRPC Integration) diff --git a/doc/architecture/LLD/timpani-n/01-initialization-main.md b/doc/architecture/LLD/timpani-n/01-initialization-main.md index f28ba9a..6aa7b2d 100644 --- a/doc/architecture/LLD/timpani-n/01-initialization-main.md +++ b/doc/architecture/LLD/timpani-n/01-initialization-main.md @@ -5,6 +5,23 @@ # LLD: Initialization & Main Entry Point +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-01 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Application Entry Point **Responsibility:** Program initialization, main execution loop coordination, graceful shutdown **Status:** 🔄 Partially Migrated (C → Rust) diff --git a/doc/architecture/LLD/timpani-n/02-configuration-management.md b/doc/architecture/LLD/timpani-n/02-configuration-management.md index cb6b5cf..1c18dcb 100644 --- a/doc/architecture/LLD/timpani-n/02-configuration-management.md +++ b/doc/architecture/LLD/timpani-n/02-configuration-management.md @@ -5,6 +5,23 @@ # LLD: Configuration Management +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-02 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Configuration System **Responsibility:** CLI parsing, configuration validation, defaults management **Status:** ✅ Complete in Rust diff --git a/doc/architecture/LLD/timpani-n/03-time-trigger-core.md b/doc/architecture/LLD/timpani-n/03-time-trigger-core.md index 89299af..3ffa334 100644 --- a/doc/architecture/LLD/timpani-n/03-time-trigger-core.md +++ b/doc/architecture/LLD/timpani-n/03-time-trigger-core.md @@ -5,6 +5,23 @@ # LLD: Time Trigger Core +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-03 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Core Runtime Engine **Responsibility:** Event loop, hyperperiod management, timer coordination **Status:** ⏸️ Not Started in Rust (C implementation documented) diff --git a/doc/architecture/LLD/timpani-n/04-task-management.md b/doc/architecture/LLD/timpani-n/04-task-management.md index 0faac3d..5ea1805 100644 --- a/doc/architecture/LLD/timpani-n/04-task-management.md +++ b/doc/architecture/LLD/timpani-n/04-task-management.md @@ -5,6 +5,23 @@ # LLD: Task Management +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-04 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Task Lifecycle Management **Responsibility:** Task list management, activation scheduling, state tracking **Status:** ⏸️ Not Started in Rust diff --git a/doc/architecture/LLD/timpani-n/05-realtime-scheduling.md b/doc/architecture/LLD/timpani-n/05-realtime-scheduling.md index 69046a2..9e1cbfd 100644 --- a/doc/architecture/LLD/timpani-n/05-realtime-scheduling.md +++ b/doc/architecture/LLD/timpani-n/05-realtime-scheduling.md @@ -5,6 +5,23 @@ # LLD: Real-Time Scheduling +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-05 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** RT Scheduling Control **Responsibility:** CPU affinity, RT priority, sched_setattr() syscalls **Status:** ⏸️ Not Started in Rust diff --git a/doc/architecture/LLD/timpani-n/06-signal-handling.md b/doc/architecture/LLD/timpani-n/06-signal-handling.md index c1aaeac..e5211ab 100644 --- a/doc/architecture/LLD/timpani-n/06-signal-handling.md +++ b/doc/architecture/LLD/timpani-n/06-signal-handling.md @@ -5,6 +5,23 @@ # LLD: Signal Handling +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-06 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Signal Management **Responsibility:** SIGALRM handlers, task signal delivery, shutdown signals **Status:** ⏸️ Not Started in Rust diff --git a/doc/architecture/LLD/timpani-n/07-ebpf-monitoring.md b/doc/architecture/LLD/timpani-n/07-ebpf-monitoring.md index b1cd018..eb397e9 100644 --- a/doc/architecture/LLD/timpani-n/07-ebpf-monitoring.md +++ b/doc/architecture/LLD/timpani-n/07-ebpf-monitoring.md @@ -5,6 +5,23 @@ # LLD: eBPF Monitoring System +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-07 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Kernel Monitoring **Responsibility:** Deadline miss detection, scheduler statistics via eBPF **Status:** ⏸️ Not Started in Rust diff --git a/doc/architecture/LLD/timpani-n/08-communication-libtrpc.md b/doc/architecture/LLD/timpani-n/08-communication-libtrpc.md index 242f2b5..72a8579 100644 --- a/doc/architecture/LLD/timpani-n/08-communication-libtrpc.md +++ b/doc/architecture/LLD/timpani-n/08-communication-libtrpc.md @@ -5,6 +5,23 @@ # LLD: Communication (libtrpc → gRPC) +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-08 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** RPC Communication **Responsibility:** Communication with timpani-o, schedule retrieval, synchronization, deadline miss reporting **Status:** ✅ Complete in Rust (gRPC client implemented) diff --git a/doc/architecture/LLD/timpani-n/09-resource-management.md b/doc/architecture/LLD/timpani-n/09-resource-management.md index cec3d51..fe9eaf6 100644 --- a/doc/architecture/LLD/timpani-n/09-resource-management.md +++ b/doc/architecture/LLD/timpani-n/09-resource-management.md @@ -5,6 +5,23 @@ # LLD: Resource Management +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-09 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Cleanup & State Management **Responsibility:** Resource cleanup, global state, graceful shutdown **Status:** ⏸️ Not Started in Rust diff --git a/doc/architecture/LLD/timpani-n/10-data-structures.md b/doc/architecture/LLD/timpani-n/10-data-structures.md index 5a983e1..7793591 100644 --- a/doc/architecture/LLD/timpani-n/10-data-structures.md +++ b/doc/architecture/LLD/timpani-n/10-data-structures.md @@ -5,6 +5,23 @@ # LLD: Data Structures +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-10 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Core Data Models **Responsibility:** Context, task info, runtime state structures **Status:** 🔄 Partial (structures defined in Rust, not used yet) diff --git a/doc/architecture/LLD/timpani-n/README.md b/doc/architecture/LLD/timpani-n/README.md index eeef026..c0b636a 100644 --- a/doc/architecture/LLD/timpani-n/README.md +++ b/doc/architecture/LLD/timpani-n/README.md @@ -5,6 +5,23 @@ # timpani-n Low-Level Design (LLD) Documentation +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-n-lld-index +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD documentation set | Eclipse timpani Team | - | + +--- + **Project:** Eclipse Timpani - Real-Time Task Orchestration Framework **Component:** timpani-n (Node Executor) **Migration:** C → Rust (In Progress - Initialization Phase Only) @@ -250,34 +267,6 @@ Check these to see what's been ported: --- -## Migration Roadmap - -### Step 1: Foundation (Current - M2) -- ✅ CLI and configuration parsing -- 🔄 Basic initialization structure -- ⏸️ Context management - -### Step 2: Core Runtime (Planned) -- ⏸️ Time trigger execution loop -- ⏸️ Hyperperiod calculation -- ⏸️ Timer management - -### Step 3: Communication (Planned) -- ⏸️ gRPC client to timpani-o -- ⏸️ Task schedule retrieval -- ⏸️ Synchronization protocol - -### Step 4: Execution (Planned) -- ⏸️ Real-time scheduling (CPU affinity, RT priority) -- ⏸️ Signal handling -- ⏸️ Task activation - -### Step 5: Monitoring (Planned) -- ⏸️ eBPF integration (aya or libbpf-rs) -- ⏸️ Deadline miss detection -- ⏸️ Performance statistics - ---- ## Important Notes diff --git a/doc/architecture/LLD/timpani-o/01-schedinfo-service.md b/doc/architecture/LLD/timpani-o/01-schedinfo-service.md index 482d894..0faf691 100644 --- a/doc/architecture/LLD/timpani-o/01-schedinfo-service.md +++ b/doc/architecture/LLD/timpani-o/01-schedinfo-service.md @@ -5,6 +5,23 @@ # LLD: SchedInfoService Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-01 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** gRPC Service **Responsibility:** Receive and process workload schedules from Pullpiri orchestrator **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/02-fault-service-client.md b/doc/architecture/LLD/timpani-o/02-fault-service-client.md index 9c71dd8..132c582 100644 --- a/doc/architecture/LLD/timpani-o/02-fault-service-client.md +++ b/doc/architecture/LLD/timpani-o/02-fault-service-client.md @@ -5,6 +5,23 @@ # LLD: FaultService Client Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-02 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** gRPC Client **Responsibility:** Report fault events (deadline misses) to Pullpiri orchestrator **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/03-dbus-server-node-service.md b/doc/architecture/LLD/timpani-o/03-dbus-server-node-service.md index 7d2452a..0dbe045 100644 --- a/doc/architecture/LLD/timpani-o/03-dbus-server-node-service.md +++ b/doc/architecture/LLD/timpani-o/03-dbus-server-node-service.md @@ -5,6 +5,23 @@ # LLD: D-Bus Server / Node Service Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-03 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Communication Server **Responsibility:** Serve scheduling information and coordinate synchronization with timpani-n nodes **Status:** ✅ Migrated (C++ D-Bus → Rust gRPC) diff --git a/doc/architecture/LLD/timpani-o/04-global-scheduler.md b/doc/architecture/LLD/timpani-o/04-global-scheduler.md index 60e946d..1bd1e43 100644 --- a/doc/architecture/LLD/timpani-o/04-global-scheduler.md +++ b/doc/architecture/LLD/timpani-o/04-global-scheduler.md @@ -5,6 +5,23 @@ # LLD: Global Scheduler Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-04 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Core Scheduling Logic **Responsibility:** Allocate tasks to nodes and CPUs using real-time scheduling algorithms **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/05-hyperperiod-manager.md b/doc/architecture/LLD/timpani-o/05-hyperperiod-manager.md index 8f43a9d..17a7ee3 100644 --- a/doc/architecture/LLD/timpani-o/05-hyperperiod-manager.md +++ b/doc/architecture/LLD/timpani-o/05-hyperperiod-manager.md @@ -5,6 +5,23 @@ # LLD: Hyperperiod Manager Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-05 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Mathematical Utility **Responsibility:** Calculate Least Common Multiple (LCM) of task periods for hyperperiod determination **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/06-node-configuration-manager.md b/doc/architecture/LLD/timpani-o/06-node-configuration-manager.md index 4f6687a..c5920bb 100644 --- a/doc/architecture/LLD/timpani-o/06-node-configuration-manager.md +++ b/doc/architecture/LLD/timpani-o/06-node-configuration-manager.md @@ -5,6 +5,23 @@ # LLD: Node Configuration Manager Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-06 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Configuration Loader **Responsibility:** Load and manage node hardware specifications from YAML configuration files **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/07-scheduler-utilities.md b/doc/architecture/LLD/timpani-o/07-scheduler-utilities.md index 57c5d68..de6ebb3 100644 --- a/doc/architecture/LLD/timpani-o/07-scheduler-utilities.md +++ b/doc/architecture/LLD/timpani-o/07-scheduler-utilities.md @@ -5,6 +5,23 @@ # LLD: Scheduler Utilities Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-07 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Helper Functions & Utilities **Responsibility:** Provide reusable scheduling utilities, feasibility checks, and mathematical functions **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/08-data-structures.md b/doc/architecture/LLD/timpani-o/08-data-structures.md index d4bbe30..98e6bc8 100644 --- a/doc/architecture/LLD/timpani-o/08-data-structures.md +++ b/doc/architecture/LLD/timpani-o/08-data-structures.md @@ -5,6 +5,23 @@ # LLD: Data Structures Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-08 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Core Data Models **Responsibility:** Define task representations, scheduling results, and type-safe enumerations **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/09-communication-protocols.md b/doc/architecture/LLD/timpani-o/09-communication-protocols.md index a862069..5c8ccdb 100644 --- a/doc/architecture/LLD/timpani-o/09-communication-protocols.md +++ b/doc/architecture/LLD/timpani-o/09-communication-protocols.md @@ -5,6 +5,23 @@ # LLD: Communication Protocols Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-09 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Protocol Definitions & Wire Format **Responsibility:** Define gRPC services, message formats, and protocol buffers for all communication **Status:** ✅ Migrated (C++ → Rust, D-Bus → gRPC) diff --git a/doc/architecture/LLD/timpani-o/10-error-handling.md b/doc/architecture/LLD/timpani-o/10-error-handling.md index 7fd8549..ab4490f 100644 --- a/doc/architecture/LLD/timpani-o/10-error-handling.md +++ b/doc/architecture/LLD/timpani-o/10-error-handling.md @@ -5,6 +5,23 @@ # LLD: Error Handling and Fault Tolerance Component +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-10 +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD document creation | Eclipse timpani Team | - | + +--- + **Component Type:** Error Management System **Responsibility:** Define error types, propagation strategies, and fault recovery mechanisms **Status:** ✅ Migrated (C++ → Rust) diff --git a/doc/architecture/LLD/timpani-o/README.md b/doc/architecture/LLD/timpani-o/README.md index 6cf0a4b..2b6d502 100644 --- a/doc/architecture/LLD/timpani-o/README.md +++ b/doc/architecture/LLD/timpani-o/README.md @@ -5,6 +5,23 @@ # timpani-o Low-Level Design (LLD) Documentation +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-o-lld-index +- **Document Status:** Draft +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0b | 2026-05-13 | Updated documentation metadata and standards compliance | LGSI-KarumuriHari | - | +| 0.0a | 2026-02-24 | Initial LLD documentation set | Eclipse timpani Team | - | + +--- + **Project:** Eclipse Timpani - Real-Time Task Orchestration Framework **Component:** timpani-o (Global Orchestrator) **Migration:** C++ → Rust diff --git a/doc/architecture/timpani_architecture.md b/doc/architecture/timpani_architecture.md index c9eccab..d9c9251 100644 --- a/doc/architecture/timpani_architecture.md +++ b/doc/architecture/timpani_architecture.md @@ -5,6 +5,22 @@ # timpani System Architecture +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-arch-system +- **Document Status:** Published +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | 2026-05-13 | Initial system architecture documentation | Eclipse timpani Team | - | + +--- + **Document Version:** 1.0 **Last Updated:** May 12, 2026 **Status:** Living Document diff --git a/doc/architecture/timpani_rust_grpc_architecture.md b/doc/architecture/timpani_rust_grpc_architecture.md index 83ad145..968c016 100644 --- a/doc/architecture/timpani_rust_grpc_architecture.md +++ b/doc/architecture/timpani_rust_grpc_architecture.md @@ -5,6 +5,22 @@ # timpani gRPC Integration Architecture +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-arch-grpc +- **Document Status:** Published +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | 2026-05-13 | Initial gRPC architecture documentation | Eclipse timpani Team | - | + +--- + **Document Version:** 1.0 **Last Updated:** May 2026 **Author:** timpani_rust Team diff --git a/doc/contribution/guidelines-en.md b/doc/contribution/guidelines-en.md index b957d94..3f27522 100644 --- a/doc/contribution/guidelines-en.md +++ b/doc/contribution/guidelines-en.md @@ -14,6 +14,7 @@ 4. [Labeling Rules by Stage](#4-labeling-rules-by-stage) 5. [Step-by-Step Workflow Guide](#5-step-by-step-workflow-guide) 6. [Automation Setup Guide](#6-automation-setup-guide) +7. [Documentation Metadata Standards](#7-documentation-metadata-standards) --- @@ -315,3 +316,151 @@ Create Requirement Issue (adminstrator) ↓ Close Issue and Update Results (adminstrator) ``` + +--- + +## 7. Documentation Metadata Standards + +### Overview + +All documentation files in the Eclipse timpani project must include standardized metadata headers to ensure traceability, version control, and proper attribution. This applies to all files in the `doc/` directory. + +### Required Metadata Header Template + +Every documentation file must start with the following structure (after the SPDX license header): + +```markdown + + +# [Document Title] + +**Document Information:** +- **Issuing Author:** [Author Name/Team] +- **Configuration ID:** [Configuration ID following naming convention] +- **Document Status:** [Draft | Review | Approved | Published] +- **Last Updated:** [YYYY-MM-DD] + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | YYYY-MM-DD | Initial document creation | [Author] | [Approver] | + +--- + +[Rest of document content...] +``` + +### Configuration ID Naming Convention + +#### LLD Documents +Format: `timpani-[component]-lld-[number]` + +**Examples:** +- `timpani-o-lld-01` - timpani-o SchedInfo Service LLD +- `timpani-o-lld-02` - timpani-o Fault Service Client LLD +- `timpani-n-lld-01` - timpani-n Initialization & Main LLD +- `timpani-n-lld-02` - timpani-n Configuration Management LLD +- `timpani-o-lld-index` - timpani-o LLD README +- `timpani-n-lld-index` - timpani-n LLD README + +#### Architecture Documents +Format: `timpani-arch-[type]` + +**Examples:** +- `timpani-arch-system` - System Architecture +- `timpani-arch-grpc` - gRPC Integration Architecture + +#### Other Documentation +Format: `timpani-[category]-[type]` + +**Examples:** +- `timpani-api-reference` - API Documentation +- `timpani-doc-structure` - Project Structure Documentation +- `timpani-doc-index` - Main Documentation Index (README) + +### Document Status Values + +| Status | Description | When to Use | +|--------|-------------|-------------| +| `Draft` | Initial creation, work in progress | Document is being written | +| `Review` | Under review | Document is complete and awaiting review | +| `Approved` | Reviewed and approved | Document has been reviewed and approved | +| `Published` | Final, published version | Document is complete and publicly available | + +### Revision History Guidelines + +1. **Version Numbering:** Use semantic versioning with alpha designation for initial versions + - Alpha version (0.0a): Initial document creation, pre-release + - Major version (1.0 → 2.0): Significant restructuring or content changes + - Minor version (1.0 → 1.1): Content updates, additions, corrections + - Patch version (1.0.0 → 1.0.1): Typo fixes, formatting (optional third digit) + +2. **Date Format:** Always use `YYYY-MM-DD` format (ISO 8601) + +3. **Comment Field:** Brief description of changes made in this version + +4. **Author Field:** Person or team who made the changes + +5. **Approver Field:** Person who approved the changes (use `-` if not yet approved) + +### Example Revision History + +```markdown +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 1.1 | 2026-05-20 | Added error handling section | Eclipse timpani Team | John Doe | +| 0.0a | 2026-05-13 | Initial LLD document creation | Eclipse timpani Team | - | +``` + +### Files Requiring Metadata + +The following types of files must include metadata headers: + +1. **LLD Documents** (`doc/architecture/LLD/`) + - All component LLD files (timpani-o/*.md, timpani-n/*.md) + - README files in each directory + +2. **Architecture Documents** (`doc/architecture/`) + - System architecture documents + - Integration architecture documents + +3. **API Documentation** (`doc/docs/api.md`) + +4. **Project Documentation** (`doc/docs/`) + - Structure documentation + - Development guides + - Release documentation + +5. **Main Documentation Index** (`doc/README.md`) + +### Metadata Maintenance + +1. **Update "Last Updated" date** whenever document content changes +2. **Add revision history entry** for significant changes +3. **Update document status** as document progresses through lifecycle +4. **Keep Configuration ID unchanged** after initial creation +5. **Preserve SPDX headers** - never remove or modify license information + +### Verification Checklist + +Before committing documentation changes, verify: + +- [ ] SPDX license header is present and correct +- [ ] Document Information section is complete +- [ ] Configuration ID follows naming convention +- [ ] Document Status is accurate +- [ ] Last Updated date is current (YYYY-MM-DD format) +- [ ] Revision History table is present +- [ ] Revision History has at least one entry (version 1.0) +- [ ] All dates use YYYY-MM-DD format +- [ ] Revision comments are meaningful and concise + +--- diff --git a/doc/docs/api.md b/doc/docs/api.md index f7fa674..781f098 100644 --- a/doc/docs/api.md +++ b/doc/docs/api.md @@ -5,6 +5,22 @@ # timpani Rust API Documentation +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-api-reference +- **Document Status:** Published +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | 2026-05-13 | Initial API documentation | Eclipse timpani Team | - | + +--- + This document describes the gRPC API and Rust module interfaces for timpani's Rust implementation. ## Table of Contents diff --git a/doc/docs/structure.md b/doc/docs/structure.md index cec564d..5b39d9b 100644 --- a/doc/docs/structure.md +++ b/doc/docs/structure.md @@ -6,6 +6,22 @@ # Project Structure +**Document Information:** +- **Issuing Author:** Eclipse timpani Team +- **Configuration ID:** timpani-doc-structure +- **Document Status:** Published +- **Last Updated:** 2026-05-13 + +--- + +## Revision History + +| Version | Date | Comment | Author | Approver | +|---------|------|---------|--------|----------| +| 0.0a | 2026-05-13 | Initial structure documentation | Eclipse timpani Team | - | + +--- + This document describes the current structure of the timpani repository. All files and folders listed here are considered stable and will remain untouched in the future, except for the `timpani_rust` folder, which will be the sole focus of ongoing development. ---