Skip to content

docs: add module_template docs boilerplate to time_daemon - #172

Open
ryan-steel wants to merge 4 commits into
eclipse-score:mainfrom
etas-contrib:docs-templates-refresh-time_daemon
Open

docs: add module_template docs boilerplate to time_daemon#172
ryan-steel wants to merge 4 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
  • docs/safety_analysis/ — DFA, FMEA, AOU requirements stubs

Structure aligns with score_process and module_template patterns for component documentation.

To keep PRs more reviewable I've split this into multiple PRs - content will be added in #153 and #171

Related ticket

Addresses #87

@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: 8865173f-918e-4d24-92cc-ea33608546b3
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 (44 packages loaded, 10 targets configured)

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

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

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

Analyzing: target //:license-check (154 packages loaded, 7055 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).
[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
[14 / 16] JavaToolchainCompileBootClasspath external/rules_java+/toolchains/platformclasspath.jar; 0s disk-cache, processwrapper-sandbox
[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: 27.595s, Critical Path: 2.39s
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
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.

1 participant