Skip to content

feat(docs): add public user manual for API description of basic usage…#128

Draft
LudwigWeise wants to merge 3 commits into
eclipse-score:mainfrom
etas-contrib:LudwigAtBosch_update_public_user_manual
Draft

feat(docs): add public user manual for API description of basic usage…#128
LudwigWeise wants to merge 3 commits into
eclipse-score:mainfrom
etas-contrib:LudwigAtBosch_update_public_user_manual

Conversation

@LudwigWeise

Copy link
Copy Markdown
Contributor

…, compile-time default, troubleshooting guide

This commit introduces the initial version of the public user manual for the sCore::time module.

The manual is structured according to the sCore documentation guidelines and 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 comprehensive configuration guide for runtime arguments.
  • A dedicated integration guide for system integrators, covering system services, runtime requirements (e.g., Linux Capabilities), and build dependencies.
  • A troubleshooting guide for diagnosing common runtime issues like unreliable clocks or IPC failures.

@github-actions

github-actions Bot commented Jul 16, 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: 28af671e-e5be-4753-9679-c58ad2e0df28
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: 
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)
Analyzing: target //:license-check (4 packages loaded, 0 targets configured)

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

Analyzing: target //:license-check (142 packages loaded, 1280 targets configured)

Analyzing: target //:license-check (153 packages loaded, 5980 targets configured)

Analyzing: target //:license-check (164 packages loaded, 9276 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 (168 packages loaded, 11172 targets configured)

Analyzing: target //:license-check (168 packages loaded, 11172 targets configured)

Analyzing: target //:license-check (168 packages loaded, 11172 targets configured)

INFO: Analyzed target //:license-check (170 packages loaded, 11422 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: 25.981s, Critical Path: 2.05s
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>]

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.
Comment thread docs/manuals/index_user_manual.rst Outdated
sCore::time User Manual
=======================

This manual describes the architecture, usage, and configuration of the sCore ``time`` module.

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.

Formatting of "sCore" isn't used anywhere else, update all to "S-CORE" to match the rest of the documentation

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Replaced "sCore" by "S-CORE" at all places.

Comment thread docs/manuals/index.rst
@@ -0,0 +1,32 @@
..

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.

Rename this to index.rst - we normally only expect to see one index.rst per folder in sphinx documentation.

See https://github.com/eclipse-score/module_template/blob/main/docs/manuals/user_manual.rst for the user manual template. I only just found it, but probably worth updating this PR to follow those conventions.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done. Renamed and updated index.rst.

@LudwigWeise LudwigWeise force-pushed the LudwigAtBosch_update_public_user_manual branch from 5d59041 to c3fd62a Compare July 16, 2026 10:33
@github-actions

Copy link
Copy Markdown

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

@LudwigWeise LudwigWeise requested a review from ryan-steel July 16, 2026 10:59
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.

2 participants