Add time slave component requirements - #151
Open
ryan-steel wants to merge 4 commits into
Open
Conversation
ryan-steel
had a problem deploying
to
workflow-approval
August 5, 2026 13:24 — with 
GitHub Actions
Error
GitHub Actions
Error
ryan-steel
had a problem deploying
to
workflow-approval
August 5, 2026 13:24 — with
GitHub Actions
Error
GitHub Actions
Error
License Check Results🚀 The license check job ran with the Bazel command: bazel run //:license-checkStatus: Click to expand output |
ryan-steel
marked this pull request as ready for review
August 5, 2026 13:29
|
The created documentation from the pull request is available at: docu-html |
There was a problem hiding this comment.
Pull request overview
Adds initial S-CORE process documentation scaffolding for the score/time_slave component, introducing draft requirements and architecture artefacts to establish traceable needs for future work.
Changes:
- Added initial component requirements (
comp_req/aou_req) and a requirements inspection checklist. - Added architecture boilerplate (static/dynamic views) and an architecture inspection checklist.
- Updated the component documentation landing page to reference the new sections.
Reviewed changes
Copilot reviewed 7 out of 9 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| score/time_slave/docs/index.rst | Reworked component landing page and toctree to point at requirements/architecture. |
| score/time_slave/docs/requirements/index.rst | Introduces requirements section toctree. |
| score/time_slave/docs/requirements/requirements.rst | Adds initial component requirements and AoU needs for time_slave. |
| score/time_slave/docs/requirements/chklst_req_inspection.rst | Adds requirements inspection checklist template for the component. |
| score/time_slave/docs/requirements/.gitkeep | Placeholder file for requirements directory. |
| score/time_slave/docs/architecture/index.rst | Introduces architecture section toctree. |
| score/time_slave/docs/architecture/component_architecture.rst | Adds architecture boilerplate including comp, static view, and dynamic view needs. |
| score/time_slave/docs/architecture/chklst_arc_inspection.rst | Adds architecture inspection checklist template for the component. |
| score/time_slave/docs/architecture/.gitkeep | Placeholder file for architecture directory. |
Suppressed comments (2)
score/time_slave/docs/architecture/chklst_arc_inspection.rst:181
- Typo in quoted string:
""n/a"has an extra quote, which reads oddly in the rendered docs.
Note: If a Review ID is not applicable for your architecture, then state ""n/a" in status and comment accordingly in remarks.
score/time_slave/docs/architecture/component_architecture.rst:74
- The
:belongs_to:targetfeat__timeis not defined anywhere in this repository (search only finds this reference). If the feature need lives in an external bundle, please make sure it’s available when building these docs; otherwise update this link to an existing feature need ID.
:belongs_to: feat__time
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| .. document:: Time Slave | ||
| :id: doc__time_slave | ||
| :status: valid |
|
|
||
| - content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling> | ||
| - reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible> | ||
| - moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection> |
|
|
||
| - content responsible (author): <contributor/committer explicitly named here, who is the main author, as can be seen in config mgt tooling> | ||
| - reviewer: <contributor/committer explicitly named here, who is the main content reviewer, must be different from content responsible> | ||
| - moderator: <committer explicitly named here, who is is the safety manager, security manager or quality manager initiating the inspection> |
| :reqtype: Functional | ||
| :security: NO | ||
| :safety: QM | ||
| :derived_from: feat_req__time__vehicle_time_sync[version==1] |
| The components are designed to cover the expectations from the feature architecture | ||
| (i.e. if already exists a definition it should be taken over and enriched). | ||
|
|
||
| A component can optional also consist of lower level components to further structure the architecture. The component and its static views can also optionally use interfaces provided by other components. |
ryan-steel
requested a deployment
to
workflow-approval
August 6, 2026 14:20 — with
GitHub Actions
Waiting
GitHub Actions
Waiting
ryan-steel
requested a deployment
to
workflow-approval
August 6, 2026 14:20 — with
GitHub Actions
Waiting
GitHub Actions
Waiting
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Improvement
Description
Add initial component documentation for time_slave following S-CORE process:
docs/requirements/)docs/architecture/) to give us valid needs to link against (comp__time_slave) - these are the template files from module_template, the only changes I've made were to update IDs, the rest of the content should be filled in a future PR.All status: invalid (draft) pending review.
Important
The added docs won't be built until the changes in #148 for updating to docs_as_code 6.0 and using docs bundles is merged. I've run the build locally with those changes implemented and the docs build without error.
Related ticket
Part of #96