Skip to content

Add user manuals for time module - #148

Open
ryan-steel wants to merge 36 commits into
eclipse-score:mainfrom
etas-contrib:docs/ryan-steel-LudwigAtBosch-user-manual
Open

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

Conversation

@ryan-steel

@ryan-steel ryan-steel commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

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)

ryan-steel and others added 9 commits July 15, 2026 12:44
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.
@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

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: 465b9592-413b-4c3d-8db5-2cee2adea2dd
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 (36 packages loaded, 10 targets configured)

Analyzing: target //:license-check (107 packages loaded, 327 targets configured)

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

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

Analyzing: target //:license-check (166 packages loaded, 9318 targets configured)

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

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

INFO: Analyzed target //:license-check (172 packages loaded, 11476 targets configured).
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions, 1 running)
INFO: From Generating Dash formatted dependency file ...:
INFO: Successfully converted 2 packages from Cargo.lock to bazel-out/k8-fastbuild/bin/formatted.txt
[15 / 16] [Prepa] Building license.check.license_check.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: 29.263s, Critical Path: 2.64s
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

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

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

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry - some more

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

@BjoernAtBosch BjoernAtBosch left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: Ryan Steel <str1yok@bosch.com>
@ryan-steel
ryan-steel deployed to workflow-approval August 18, 2026 14:00 — with GitHub Actions Active
@ryan-steel
ryan-steel deployed to workflow-approval August 18, 2026 14:00 — with GitHub Actions Active
Comment thread docs/module/manuals/api_description/api_usage.rst
…o docs/ryan-steel-LudwigAtBosch-user-manual
…o docs/ryan-steel-LudwigAtBosch-user-manual
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: In Progress

Development

Successfully merging this pull request may close these issues.

docs/manuals/: Create user manual

6 participants