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: c6108468-63cd-4dbe-b42f-b563ca362f32
Computing main repo mapping: 
WARNING: /home/runner/work/time/time/MODULE.bazel:13:7: The attribute 'compatibility_level' in module() is a no-op and will be removed in a future Bazel release. Please remove it from your MODULE.bazel file.
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: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

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

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

Analyzing: target //:license-check (152 packages loaded, 3127 targets configured)

Analyzing: target //:license-check (154 packages loaded, 6215 targets configured)

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

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

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

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

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

Analyzing: target //:license-check (169 packages loaded, 11296 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 targets configured).
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: 28.559s, Critical Path: 2.46s
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-10T08:02:02Z

+Using Existing Test Utilities
+=============================
+
+The framework already provides ``ClockTestFactory<Tag>`` in


Suggested change

The framework already provides ``ClockTestFactory<Tag>`` in

The framework provides ``ClockTestFactory<Tag>`` in

lavrovvalera · 2026-08-10T08:28:52Z

+
+.. _ components::
+
+Components


I'm a bit struggling, why dowe have this subfoler here...

lavrovvalera · 2026-08-10T08:30:37Z

+#######
+
+.. toctree::
+   :titlesonly:


Lets corss check the manual with the folder structur docuemtn
https://eclipse-score.github.io/score/main/contribute/general/folder.html

I think, we not following it compeltely.
I would rather prefer to have even the folder s with the single index.rst file to

follow the apporvied folder structure

ave the flexibility to add some more files, diagrams, rst files, whatever there in future.

lavrovvalera · 2026-08-10T08:38:53Z

+
+.. _manual_time_api_usage:
+
+API Usage: Accessing Vehicle Time


I would even think to move these API or score/time module API to modul API, because it is the main API of the module, I would say
means, to move it to the docs/manuals/api_description/ ...
and here keep the details or subcomponent manual

Check the folder structure https://eclipse-score.github.io/score/main/contribute/general/folder.html

lavrovvalera · 2026-08-10T08:42:07Z

+       elapsed += std::chrono::seconds{2};
+       EXPECT_TRUE(handler.HasTimedOut(timeout));
+
+   } // clock_override is destroyed here; real backend is restored.


real backend is restored.-> I don't think, it is true

Ryan Steel and others added 9 commits July 15, 2026 12:44

docs: add examples user documentation

04085a8

docs: remove API specifics from the examples docs

00f95df

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…

0f17969

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

add user manuals

1cb0e96

chore: address comments

1ca194b

chore: update docs_as_code version and use score_sphinx_bundle

fe616ec

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

Open

use docs_as_code 6.0 bundles

4455752

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

chore: format

c8de935

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

894e309

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

Open

AZB #101279 Quality pack targets #150

Open

Update dependency score_docs_as_code to v6 - autoclosed #145

Closed

add time_daemon component requirements #153

Open

This was referenced Aug 6, 2026

Restructure documentation to meet S-CORE conventions #123

Draft

Update dependency score_docs_as_code to v4.6.1 #130

Closed

lavrovvalera reviewed Aug 6, 2026

View reviewed changes

chore: address comments

9da9c42

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

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

docs: update safety tag to fix build

d6cb760

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from bf05f16 to d6cb760 Compare August 6, 2026 15:10

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

ryan-steel requested a review from lavrovvalera August 7, 2026 13:41

lavrovvalera reviewed Aug 10, 2026

View reviewed changes

Navigation Menu

Uh oh!

Add user manuals for time module - #148

Add user manuals for time module#148
ryan-steel wants to merge 14 commits into
eclipse-score:mainfrom
etas-contrib:docs/ryan-steel-LudwigAtBosch-user-manual

ryan-steel commented Aug 4, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Aug 4, 2026 •

edited

Loading

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!

lavrovvalera Aug 10, 2026

Uh oh!

lavrovvalera Aug 10, 2026

Uh oh!

lavrovvalera Aug 10, 2026

Uh oh!

lavrovvalera Aug 10, 2026

Uh oh!

lavrovvalera Aug 10, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

	The framework already provides ``ClockTestFactory<Tag>`` in
	The framework provides ``ClockTestFactory<Tag>`` in


		.. _ 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!

lavrovvalera Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

lavrovvalera Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

lavrovvalera Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

lavrovvalera Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

lavrovvalera Aug 10, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ryan-steel commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading