Skip to content

Add user manuals for time module - #148

Open
ryan-steel wants to merge 14 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 14 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: 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

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown

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

Comment thread docs/manuals/user_manual.rst Outdated
Comment thread docs/manuals/user_manual.rst Outdated
Comment thread score/time/docs/manuals/user_manual.rst Outdated
Comment thread score/time/docs/manuals/user_manual.rst Outdated
Comment thread score/time/docs/manuals/user_manual.rst Outdated
Comment thread score/time/docs/manuals/user_manual.rst Outdated
Comment thread score/time/docs/manuals/api_description/api_usage.rst Outdated
Comment thread score/time/docs/manuals/api_description/testing_guide.rst Outdated
@ryan-steel
ryan-steel force-pushed the docs/ryan-steel-LudwigAtBosch-user-manual branch from bf05f16 to d6cb760 Compare August 6, 2026 15:10
@ryan-steel
ryan-steel requested a review from lavrovvalera August 7, 2026 13:41
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

3 participants