Move documentation to right folders and add user manual#97
Open
RolandJentschETAS wants to merge 1 commit into
Open
Move documentation to right folders and add user manual#97RolandJentschETAS wants to merge 1 commit into
RolandJentschETAS wants to merge 1 commit into
Conversation
RolandJentschETAS
requested review from
PandaeDo,
aschemmel-tech,
masc2023 and
pahmann
as code owners
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //:license-checkStatus: Click to expand output |
|
The created documentation from the pull request is available at: docu-html |
PandaeDo
requested changes
Jun 22, 2026
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
Contributor
There was a problem hiding this comment.
Please rename document from user_manuel.rst to user_manual.rst
| @@ -0,0 +1,274 @@ | |||
| .. | |||
Contributor
There was a problem hiding this comment.
I don't like that we create another document that consists mainly on informations that are available. It will lead to a point that we will see more unmaintained documentation because you have to have a look on too many different places. Would recommend to avoid completely doubled information's and check if it's needed to enlarge existing before we create something new.
| ########### | ||
|
|
||
|
|
||
| .. attention:: |
Contributor
There was a problem hiding this comment.
I can't see some metadata. Should be deleted.
| .. note:: | ||
| This is a template user manual. Replace placeholder text with actual module-specific information. | ||
|
|
||
| Feature List |
Contributor
There was a problem hiding this comment.
Why we have this overview? In the index.rst in the root folder we have all these information's. Please delete it
| * Feature security artifacts: :doc:`/docs/features/feature_example/security_analysis/index` | ||
| * Feature planning artifacts (safety/security): :doc:`/docs/features/feature_example/safety_planning/index` and :doc:`/docs/features/feature_example/security_planning/index` | ||
|
|
||
| Platform Requirements |
Contributor
There was a problem hiding this comment.
I see there no platform requirements.
| Module Configuration Details | ||
| ============================= | ||
|
|
||
| The ``project_config.bzl`` file at the root of the module defines metadata used by Bazel macros. |
Contributor
There was a problem hiding this comment.
https://eclipse-score.github.io/score/main/users_guide/building_simple_application/first_score_module.html here are the information's.
| Integrating with Your Project | ||
| ------------------------------ | ||
|
|
||
| 1. Add the module to your Bazel workspace: |
Contributor
There was a problem hiding this comment.
| deps = ["@module_template//score/component_example:component"], | ||
| ) | ||
|
|
||
| 3. Include headers and compile your code |
Contributor
There was a problem hiding this comment.
Stop reading here. Same as above. I don't think we need this additional document.
| .. document:: [Your Component Name] Requirements | ||
| :id: doc__mod_temp_component_name_requirements | ||
| :status: draft | ||
| :safety: ASIL_B |
Contributor
There was a problem hiding this comment.
I think we should add versions to all templates compare to https://eclipse-score.github.io/process_description/main/folder_templates/platform/features/feature_name/architecture/index.html
| ├── project_config.bzl # Project metadata used by Bazel macros | ||
| └── README.md # Entry point of the repository | ||
|
|
||
| Module / Feature Documentation |
Contributor
There was a problem hiding this comment.
Why the module/feature documentation is removed and replaced afterwards with module documentation? I don't see a real benefit by doing this.
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
2 participants
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.
This pull request introduces several improvements and additions to the documentation structure and templates for the project. The main focus is on enhancing the modularity and clarity of the documentation, providing comprehensive templates for user and component manuals, and reorganizing the documentation layout for better usability.
Summary of Most Important Changes:
1. Documentation Structure and Template Enhancements
user_manuel.rst) covering installation, configuration, usage, integration, troubleshooting, safety, security, and contribution guidelines. This template is now referenced in the manuals table of contents. [1] [2]component_architecture.rst) for use in component-level documentation, including sections for requirements, static and dynamic architecture, interfaces, and internal components.2. Improvements to Documentation Organization
index.rst) to:3. Cleanup and Streamlining
These changes collectively improve the maintainability, clarity, and extensibility of the project's documentation, making it easier for new users and contributors to get started and for teams to document features and components in a consistent manner.