diff --git a/docs/conf.py b/docs/conf.py index cf13475..2a47361 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -20,7 +20,7 @@ # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = "Module Template Project" +project = "S-CORE Time" project_url = "https://eclipse-score.github.io/module_template/" project_prefix = "MODULE_TEMPLATE_" author = "S-CORE" diff --git a/docs/index.rst b/docs/index.rst index f8e53da..14bf088 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,10 +12,10 @@ # SPDX-License-Identifier: Apache-2.0 # ******************************************************************************* -Module Template Documentation -============================= +TimeDaemon Documentation +======================== -This documentation describes the structure, usage and configuration of the Bazel-based C++/Rust module template. +This documentation describes the **TimeDaemon** and the **score::time** module. .. contents:: Table of Contents :depth: 2 @@ -24,20 +24,25 @@ This documentation describes the structure, usage and configuration of the Bazel Overview -------- -This repository provides a standardized setup for projects using **C++** or **Rust** and **Bazel** as a build system. -It integrates best practices for build, test, CI/CD and documentation. +**TimeDaemon** is a non-AUTOSAR adaptive process designed to provide synchronized vehicle time to client applications. +It supports multiple time bases including **in-vehicle synchronized time** (PTP - Precision Time Protocol) and +**external synchronized time** (absolute time base). The daemon retrieves time information from the respective time sources, +verifies and validates the timepoints, and distributes this time information across multiple clients through efficient IPC mechanisms. -Requirements ------------- +The main responsibilities of TimeDaemon include: -.. stkh_req:: Example Functional Requirement - :id: stkh_req__docgen_enabled__example - :status: valid - :safety: QM - :security: YES - :reqtype: Functional - :rationale: Ensure documentation builds are possible for all modules +- **Providing current Vehicle time** to different applications +- **Setting synchronization qualifiers** (e.g., Synchronized, Timeout, etc.) +- **Providing diagnostic information** for system monitoring +- **Supporting additional verification mechanisms** such as QualifiedVehicleTime (QVT) for safety-critical applications +For a detailed concept and architectural design, please refer to the :doc:`TimeDaemon Concept Documentation