Skip to content

docs: add module_template docs boilerplate to time_daemon - #172

Merged
mariuswbr merged 5 commits into
eclipse-score:mainfrom
etas-contrib:docs-templates-refresh-time_daemon
Aug 18, 2026
Merged

docs: add module_template docs boilerplate to time_daemon#172
mariuswbr merged 5 commits into
eclipse-score:mainfrom
etas-contrib:docs-templates-refresh-time_daemon

Conversation

@ryan-steel

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

Copy link
Copy Markdown
Contributor

Description

Adds module_template-based documentation structure to score/time_daemon:

  • docs/index.rst — Component overview with comp__ definition
  • docs/requirements/requirements.rst — Component requirements with ASIL_B/security:YES
  • docs/detailed_design/index.rst — Internal unit architecture and implementation details

Structure aligns with score_process and module_template patterns for component documentation.

To keep PRs more reviewable I've split this into multiple PRs.

Related ticket

Part of #95

Stack Info

Part of stacked PR chain (layer 1 of 3):

  1. docs: add module_template docs boilerplate to time_daemon #172 (this PR)
  2. add time_daemon component requirements #153
  3. docs: migrate time_daemon detailed design from docs/features #171

Commits in this layer: 5

@github-actions

github-actions Bot commented Aug 14, 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: c7f1e4c9-d5e1-48ee-ac71-b261f355f14f
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 (80 packages loaded, 10 targets configured)

Analyzing: target //:license-check (151 packages loaded, 3132 targets configured)

Analyzing: target //:license-check (155 packages loaded, 6190 targets configured)

Analyzing: target //:license-check (166 packages loaded, 9320 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 (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).
[1 / 8] [Prepa] Creating source manifest for //:license.check.license_check
[12 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox ... (2 actions 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] 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: 34.973s, Critical Path: 1.81s
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

Copy link
Copy Markdown

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

@ryan-steel
ryan-steel marked this pull request as ready for review August 14, 2026 10:01
@ryan-steel ryan-steel changed the title docs: add module_template docs to time_daemon docs: add module_template docs boilerplate to time_daemon Aug 14, 2026
@ryan-steel
ryan-steel force-pushed the docs-templates-refresh-time_daemon branch from f3f33fb to 02f5a4b Compare August 17, 2026 12:45

@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

Comment thread score/time_daemon/docs/safety_analysis/aou_requirements.rst Outdated

@mariuswbr mariuswbr 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.

I see all the process things were added. Looks good. Looking forward to seeing it filled with real content. :-)

@mariuswbr
mariuswbr merged commit 27e173c into eclipse-score:main Aug 18, 2026
16 of 18 checks passed
@github-project-automation github-project-automation Bot moved this from In Progress to Done in TIM - Time FT Aug 18, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants