Move documentation to right folders and add user manual#97
Move documentation to right folders and add user manual#97RolandJentschETAS wants to merge 16 commits 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 |
| @@ -0,0 +1,274 @@ | |||
| .. | |||
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.
There was a problem hiding this comment.
Moving content was a mistake. I want to introduce an end customer documentation (for example fr application developers). So I placed back the information for module developers.
| .. note:: | ||
| This is a template user manual. Replace placeholder text with actual module-specific information. | ||
|
|
||
| Feature List |
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
There was a problem hiding this comment.
See above document ...
| deps = ["@module_template//score/component_example:component"], | ||
| ) | ||
|
|
||
| 3. Include headers and compile your code |
There was a problem hiding this comment.
Stop reading here. Same as above. I don't think we need this additional document.
There was a problem hiding this comment.
See changed content now please.
| ├── project_config.bzl # Project metadata used by Bazel macros | ||
| └── README.md # Entry point of the repository | ||
|
|
||
| Module / Feature Documentation |
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.
There was a problem hiding this comment.
Because from the folder structure there is a difference between module and features and the belonging work products. Otherwise it will be possibly confusing. See https://eclipse-score.github.io/score/main/contribute/general/folder.html#module-folder-structure
There was a problem hiding this comment.
Feature lost was a mistake. I tried to split that. But i'm not sure if this makes sense.
aschemmel-tech
left a comment
aschemmel-tech
left a comment
There was a problem hiding this comment.
Need to discuss new work product "user manual" in the process community, incl. what level it is
3 participants
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.