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: 8a3b58fa-33ab-465a-a273-512931078036
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: 
Analyzing: target //:license-check (4 packages loaded)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

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

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

Analyzing: target //:license-check (160 packages loaded, 3369 targets configured)

Analyzing: target //:license-check (161 packages loaded, 7037 targets configured)

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

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

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (175 packages loaded, 11305 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

Analyzing: target //:license-check (176 packages loaded, 11429 targets configured)

INFO: Analyzed target //:license-check (177 packages loaded, 11555 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
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: 37.930s, Critical Path: 2.12s
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

…o docs/ryan-steel-LudwigAtBosch-user-manual

NEOatNHNG

Content already reviewed by team.

NEOatNHNG · 2026-08-25T07:04:41Z

@ryan-steel The documentation build shows now the following output which might indicate that it is confused on what should be the main page where the documentation is kept at (module/index or module/manuals/user_manual). Can you check whether it makes sense or indicates a bug?

checking consistency... /home/runner/work/time/time/docs/module/manuals/troubleshooting_guide.rst: document is referenced in multiple toctrees: ['module/manuals/index', 'module/manuals/user_manual'], selecting: module/manuals/user_manual <- module/manuals/troubleshooting_guide
/home/runner/work/time/time/score/time_daemon/docs/index.rst: document is referenced in multiple toctrees: ['module/index', 'index'], selecting: module/index <- time_daemon/index
/home/runner/work/time/time/score/time_daemon/docs/manuals/user_manual.rst: document is referenced in multiple toctrees: ['time_daemon/index', 'module/manuals/user_manual'], selecting: time_daemon/index <- time_daemon/manuals/user_manual
/home/runner/work/time/time/score/time_slave/docs/index.rst: document is referenced in multiple toctrees: ['module/index', 'index'], selecting: module/index <- time_slave/index
/home/runner/work/time/time/score/time_slave/docs/manuals/user_manual.rst: document is referenced in multiple toctrees: ['module/manuals/user_manual', 'time_slave/index'], selecting: time_slave/index <- time_slave/manuals/user_manual
done

BjoernAtBosch

LGTM

lavrovvalera

LGTM

BjoernAtBosch

LGTM again

ryan-steel · 2026-08-25T11:09:58Z

@ryan-steel The documentation build shows now the following output which might indicate that it is confused on what should be the main page where the documentation is kept at (module/index or module/manuals/user_manual). Can you check whether it makes sense or indicates a bug?

checking consistency... /home/runner/work/time/time/docs/module/manuals/troubleshooting_guide.rst: document is referenced in multiple toctrees: ['module/manuals/index', 'module/manuals/user_manual'], selecting: module/manuals/user_manual <- module/manuals/troubleshooting_guide
/home/runner/work/time/time/score/time_daemon/docs/index.rst: document is referenced in multiple toctrees: ['module/index', 'index'], selecting: module/index <- time_daemon/index
/home/runner/work/time/time/score/time_daemon/docs/manuals/user_manual.rst: document is referenced in multiple toctrees: ['time_daemon/index', 'module/manuals/user_manual'], selecting: time_daemon/index <- time_daemon/manuals/user_manual
/home/runner/work/time/time/score/time_slave/docs/index.rst: document is referenced in multiple toctrees: ['module/index', 'index'], selecting: module/index <- time_slave/index
/home/runner/work/time/time/score/time_slave/docs/manuals/user_manual.rst: document is referenced in multiple toctrees: ['module/manuals/user_manual', 'time_slave/index'], selecting: time_slave/index <- time_slave/manuals/user_manual
done

There was some doubling of entries in toctrees - I've cleaned up in the latest commit, no more consistency warnings.

This section should be added back once we have release notes for score_time.

BjoernAtBosch

LGTM

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

Open

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

Open

feat: Quality pack targets #150

Open

Update dependency score_docs_as_code to v6 - autoclosed #145

Closed

add time_daemon component requirements #153

Open

fix build

8da4d76

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

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

2d6626a

…o docs/ryan-steel-LudwigAtBosch-user-manual

ryan-steel had a problem deploying to workflow-approval August 19, 2026 16:08 — with GitHub Actions Error

BjoernAtBosch suggested changes Aug 20, 2026

View reviewed changes

Comment thread score/time_daemon/docs/index.rst

ryan-steel had a problem deploying to workflow-approval August 21, 2026 15:04 — with GitHub Actions Error

fix headers in index

d9b38ba

ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from 9d17948 to d9b38ba Compare August 21, 2026 15:05

ryan-steel had a problem deploying to workflow-approval August 21, 2026 15:05 — with GitHub Actions Error

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

47a5833

…o docs/ryan-steel-LudwigAtBosch-user-manual

ryan-steel had a problem deploying to workflow-approval August 21, 2026 15:05 — with GitHub Actions Error

ryan-steel and others added 2 commits August 21, 2026 16:07

fix merge issue

42fcdb6

Merge branch 'main' into docs/ryan-steel-LudwigAtBosch-user-manual

5c4638d

NEOatNHNG previously approved these changes Aug 25, 2026

View reviewed changes

BjoernAtBosch approved these changes Aug 25, 2026

View reviewed changes

lavrovvalera approved these changes Aug 25, 2026

View reviewed changes

BjoernAtBosch added 2 commits August 25, 2026 12:04

Merge branch 'main' into docs/ryan-steel-LudwigAtBosch-user-manual

d468594

Fix copyright headers

8e6abd2

BjoernAtBosch approved these changes Aug 25, 2026

View reviewed changes

remove doubled toctree entries

16cb861

BjoernAtBosch suggested changes Aug 25, 2026

View reviewed changes

Comment thread docs/module/manuals/user_manual.rst Outdated

remove version history from user manual

65d80eb

This section should be added back once we have release notes for score_time.

BjoernAtBosch approved these changes Aug 25, 2026

View reviewed changes

NEOatNHNG approved these changes Aug 25, 2026

View reviewed changes

Navigation Menu

Add user manuals for time module - #148

Add user manuals for time module#148
NEOatNHNG merged 44 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!

NEOatNHNG left a comment

Uh oh!

NEOatNHNG commented Aug 25, 2026

Uh oh!

BjoernAtBosch left a comment

Uh oh!

lavrovvalera left a comment

Uh oh!

BjoernAtBosch left a comment

Uh oh!

ryan-steel commented Aug 25, 2026

Uh oh!

Uh oh!

BjoernAtBosch left a comment

Uh oh!

This branch is waiting to be deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

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!

NEOatNHNG left a comment

Choose a reason for hiding this comment

Uh oh!

NEOatNHNG commented Aug 25, 2026

Uh oh!

BjoernAtBosch left a comment

Choose a reason for hiding this comment

Uh oh!

lavrovvalera left a comment

Choose a reason for hiding this comment

Uh oh!

BjoernAtBosch left a comment

Choose a reason for hiding this comment

Uh oh!

ryan-steel commented Aug 25, 2026

Uh oh!

Uh oh!

BjoernAtBosch left a comment

Choose a reason for hiding this comment

Uh oh!

This branch is waiting to be deployed

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ryan-steel commented Aug 4, 2026 •

edited

Loading

github-actions Bot commented Aug 4, 2026 •

edited

Loading