Add user manuals for time module by ryan-steel · Pull Request #148 · eclipse-score/time

ryan-steel · 2026-08-04T14:33:22Z

Improvement

Adds user-facing documentation for S-CORE time module and its key components.

Description

Added module manuals for integration and troubleshooting
Added component manuals for time library, TimeSlave, and TimeDaemon
Added main index links so users can navigate module and component docs
Updates score_docs_as_code to 6.0.0 and updates score_time to use new docs bundles.

Related Ticket

closes #125 (improvement ticket)

It includes - An overall architecture introduction and a guide for choosing the right clock. - A detailed API description covering basic usage, lifecycle management, advanced subscriptions, and unit-testing patterns. - A dedicated integration guide for system integrators. - A troubleshooting guide for diagnosing common runtime issues.

…rib/score_inc_time into docs/ryan-steel-LudwigAtBosch-user-manual

github-actions · 2026-08-04T14:34:36Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.6.0) and connecting to it...
INFO: Invocation ID: ab4e72ad-f632-4736-9df5-cbe673d70b7c
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 3 packages loaded
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Loading: 3 packages loaded
    currently loading: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

Analyzing: target //:license-check (29 packages loaded, 10 targets configured)

Analyzing: target //:license-check (85 packages loaded, 10 targets configured)

Analyzing: target //:license-check (143 packages loaded, 2895 targets configured)

Analyzing: target //:license-check (155 packages loaded, 6408 targets configured)

Analyzing: target //:license-check (159 packages loaded, 9278 targets configured)

Analyzing: target //:license-check (165 packages loaded, 9313 targets configured)

Analyzing: target //:license-check (167 packages loaded, 9338 targets configured)

Analyzing: target //:license-check (167 packages loaded, 9338 targets configured)

Analyzing: target //:license-check (167 packages loaded, 9338 targets configured)

Analyzing: target //:license-check (170 packages loaded, 11226 targets configured)

INFO: Analyzed target //:license-check (172 packages loaded, 11476 targets configured).
[1 / 13] Writing repo mapping manifest for //:license.check.license_check; 0s local ... (3 actions running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[14 / 16] [Prepa] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar
[15 / 16] Building license.check.license_check.jar (); 0s disk-cache, multiplex-worker
INFO: Found 1 target...
Target //:license.check.license_check up-to-date:
  bazel-bin/license.check.license_check
  bazel-bin/license.check.license_check.jar
INFO: Elapsed time: 29.610s, Critical Path: 2.69s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/license.check.license_check ./formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-08-04T14:39:48Z

The created documentation from the pull request is available at: docu-html

lavrovvalera · 2026-08-13T14:56:59Z

+
+.. _ components::
+
+Components


I don't see the components subfolder in the folder structure document
https://eclipse-score.github.io/score/main/contribute/general/folder.html

so, my question is why it is still here and do we really need it?

It's in the module template - gives a place for the docs_as_code docs_bundles to be injected.

@anmittag can you confirm whether this will be added to folder.rst?

as the components are part of the /score subfolder you can delete it. template will be unpdated.

The components are part of the score/ subfolder, but this gives us a place to mount the docs bundles generated from the docs_as_code directive in BUILD. Can you give an alternative for where it should be mounted?

into docs/ryan-steel-LudwigAtBosch-user-manual

BjoernAtBosch · 2026-08-14T13:30:47Z

+       const auto system_snapshot = score::time::SystemClock::GetInstance().Now();
+       const auto steady_snapshot = score::time::SteadyClock::GetInstance().Now();
+       const auto high_res_snapshot = score::time::HighResSteadyClock::GetInstance().Now();
+       const auto vehicle_snapshot = score::time::VehicleClock::GetInstance().Now();


Not sure, if this is correct for the vehicle time.
@lavrovvalera: Don't we need the call to init for this?

BjoernAtBosch · 2026-08-14T13:41:58Z

+     - Key Characteristic
+     - Typical Use Case
+   * - ``VehicleTime``
+     - High-precision, PTP-synchronized, quality-assured network time.


Ah - forgot to mention this last time:
Is this really about precision or more about accuracy?
In short:

Accuracy - the better the lower the absolute deviation from the master

Precision - low spreading if queried multiple times
(Ask Google or Wikipedia for difference between accuracy, precision, and resolution)

BjoernAtBosch · 2026-08-14T13:55:08Z

+       const auto system_tp = system_snapshot.TimePoint();
+       const auto steady_tp = steady_snapshot.TimePoint();
+       const auto high_res_tp = high_res_snapshot.TimePoint();
+       const auto vehicle_tp = vehicle_snapshot.TimePoint();


We suggest the vehicle time is always valid, here. We should at least add this check:

if (vehicle_snapshot.Status().HasBeenSynchronized()) { const auto vehicle_tp = vehicle_snapshot.TimePoint(); }

ryan-steel and others added 9 commits July 15, 2026 12:44

docs: add examples user documentation

848c63d

docs: remove API specifics from the examples docs

853cba3

fix(docs): Correct RST structure and apply review feedback

c3fd62a

fix(docs): Integrate user manual into main documentation toctree

094c15e

Merge branch 'docs/document-examples' of https://github.com/etas-cont…

dac6b19

…rib/score_inc_time into docs/ryan-steel-LudwigAtBosch-user-manual

add user manuals

e9b552b

chore: address comments

fed85cb

chore: update docs_as_code version and use score_sphinx_bundle

a2771df

github-project-automation Bot added this to TIM - Time FT Aug 4, 2026

github-project-automation Bot moved this to In Progress in TIM - Time FT Aug 4, 2026

ryan-steel had a problem deploying to workflow-approval August 4, 2026 14:33 — with GitHub Actions Error

ryan-steel mentioned this pull request Aug 4, 2026

Add user manuals for time module #133

Closed

ryan-steel mentioned this pull request Aug 4, 2026

Add ts client component requirements #149

Draft

use docs_as_code 6.0 bundles

4ef0e0e

ryan-steel had a problem deploying to workflow-approval August 5, 2026 10:30 — with GitHub Actions Error

chore: format

96d8f66

ryan-steel requested a deployment to workflow-approval August 5, 2026 10:37 — with GitHub Actions Waiting

ryan-steel had a problem deploying to workflow-approval August 5, 2026 10:37 — with GitHub Actions Error

remove include_patterns

61e7a7e

ryan-steel had a problem deploying to workflow-approval August 5, 2026 12:54 — with GitHub Actions Error

This was referenced Aug 5, 2026

Add time slave component requirements #151

Draft

AZB #101279 Quality pack targets #150

Open

Update dependency score_docs_as_code to v6 - autoclosed #145

Closed

add time_daemon component requirements #153

Draft

ryan-steel added 4 commits August 12, 2026 15:19

docs: use latest module_template layout, update to docs_as_code v7

d738c21

docs: update template IDs for module time

6017036

chore: update to docs-as-code 7.0.1

6cca2e7

chore: format

70c6f70

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from fc5eec7 to 1345156 Compare August 12, 2026 14:19

ryan-steel had a problem deploying to workflow-approval August 12, 2026 14:20 — with GitHub Actions Error

ryan-steel requested a review from lavrovvalera August 12, 2026 14:30

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from 1345156 to 70c6f70 Compare August 13, 2026 10:25

ryan-steel had a problem deploying to workflow-approval August 13, 2026 10:25 — with GitHub Actions Error

BjoernAtBosch suggested changes Aug 13, 2026

View reviewed changes

lavrovvalera reviewed Aug 13, 2026

View reviewed changes

ryan-steel added 2 commits August 14, 2026 11:43

chore: address comments

68e56c4

chore: Merge branch 'main' of https://github.com/etas-contrib/score_time

4835b25

into docs/ryan-steel-LudwigAtBosch-user-manual

anmittag reviewed Aug 14, 2026

View reviewed changes

Comment thread docs/index.rst

ryan-steel added 2 commits August 14, 2026 12:05

chore: update docs_as_code to 7.1.0

19bcd4b

chore: address comments

db0c9bc

ryan-steel had a problem deploying to workflow-approval August 14, 2026 11:26 — with GitHub Actions Error

docs: add module summary

08c590c

ryan-steel had a problem deploying to workflow-approval August 14, 2026 11:33 — with GitHub Actions Error

ryan-steel had a problem deploying to workflow-approval August 14, 2026 12:01 — with GitHub Actions Error

docs: move time lib user manual to module level

2c86705

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from edaa513 to 2c86705 Compare August 14, 2026 12:08

ryan-steel requested a deployment to workflow-approval August 14, 2026 12:08 — with GitHub Actions Waiting

BjoernAtBosch reviewed Aug 14, 2026

View reviewed changes


		.. _ components::

		Components

Uh oh!

Conversation

ryan-steel commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Improvement

Description

Related Ticket

Uh oh!

github-actions Bot commented Aug 4, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions Bot commented Aug 4, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lavrovvalera Aug 13, 2026

Choose a reason for hiding this comment

Uh oh!

ryan-steel Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

anmittag Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

ryan-steel Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BjoernAtBosch Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch Aug 14, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ryan-steel commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading