feat(docs): add public user manual for API description of basic usage…#128
feat(docs): add public user manual for API description of basic usage…#128LudwigWeise wants to merge 3 commits into
Conversation
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
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.
| sCore::time User Manual | ||
| ======================= | ||
|
|
||
| This manual describes the architecture, usage, and configuration of the sCore ``time`` module. |
There was a problem hiding this comment.
Formatting of "sCore" isn't used anywhere else, update all to "S-CORE" to match the rest of the documentation
There was a problem hiding this comment.
Done. Replaced "sCore" by "S-CORE" at all places.
| @@ -0,0 +1,32 @@ | |||
| .. | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Done. Renamed and updated index.rst.
5d59041 to
c3fd62a
Compare
|
The created documentation from the pull request is available at: docu-html |
…, 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: