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: dd6efab6-bd72-4752-9dee-2c7a9c7d4e4a
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: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

Analyzing: target //:license-check (146 packages loaded, 3116 targets configured)

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

Analyzing: target //:license-check (164 packages loaded, 9319 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)

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

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

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

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

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

Analyzing: target //:license-check (171 packages loaded, 11350 targets configured)

INFO: Analyzed target //:license-check (172 packages loaded, 11476 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: 38.785s, Critical Path: 2.04s
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

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

BjoernAtBosch

Sorry - some more

BjoernAtBosch

LGTM

Signed-off-by: Ryan Steel <str1yok@bosch.com>

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 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 had a problem deploying to workflow-approval August 14, 2026 12:08 — with GitHub Actions Error

BjoernAtBosch reviewed Aug 14, 2026

View reviewed changes

Comment thread docs/module/manuals/api_description/api_usage.rst Outdated

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

Comment thread docs/module/manuals/api_description/api_usage.rst Outdated

chore: address comments

7ed1efc

ryan-steel had a problem deploying to workflow-approval August 18, 2026 09:58 — with GitHub Actions Error

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

7a823ae

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

ryan-steel had a problem deploying to workflow-approval August 18, 2026 09:59 — with GitHub Actions Error

chore: format

3c24fd7

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

BjoernAtBosch suggested changes Aug 18, 2026

View reviewed changes

Comment thread docs/module/manuals/api_description/api_usage.rst Outdated

Comment thread docs/module/manuals/api_description/api_usage.rst Outdated

Comment thread docs/module/manuals/api_description/api_usage.rst Outdated

chore: address comments

44e2c9b

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

BjoernAtBosch approved these changes Aug 18, 2026

View reviewed changes

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

3c2bff9

Signed-off-by: Ryan Steel <str1yok@bosch.com>

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

docs: fix build

6b29f59

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

fix build

ce2a148

ryan-steel deployed to workflow-approval August 18, 2026 14:00 — with GitHub Actions Active

Navigation Menu

Uh oh!

Add user manuals for time module - #148

Add user manuals for time module#148
ryan-steel wants to merge 33 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!

BjoernAtBosch left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BjoernAtBosch left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

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!

BjoernAtBosch left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

BjoernAtBosch left a comment

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