Move documentation to right folders and add user manual

[RolandJentschETAS]

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

• Added a comprehensive user manual template (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]
• Introduced a detailed component architecture documentation template (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

• Updated the main documentation index (index.rst) to:
  • Clarify and expand the directory structure for manuals, highlighting optional user-centric documentation such as configuration guides, examples, API descriptions, and performance analysis. [1] [2]
  • Replace the previous quick start, configuration, and component documentation sections with a more concise and modular template, delegating detailed documentation to the respective new templates.
  • Correct the reference to the component architecture template to point to the new file.

3. Cleanup and Streamlining

• Removed the outdated "Module Viewpoint" section from the feature architecture documentation, focusing the section on used components and streamlining the logical interfaces documentation.

---

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.

[github-actions]

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run --lockfile_mode=error //: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: 993832e2-c5e4-4590-9e1d-73b26bc04e4c
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Loading: 0 packages loaded
    currently loading: 
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //:license-check (1 packages loaded, 0 targets configured)

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

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

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

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

Analyzing: target //:license-check (140 packages loaded, 1559 targets configured)

Analyzing: target //:license-check (156 packages loaded, 4420 targets configured)

Analyzing: target //:license-check (158 packages loaded, 7844 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (163 packages loaded, 8151 targets configured)

Analyzing: target //:license-check (167 packages loaded, 10160 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

Analyzing: target //:license-check (168 packages loaded, 10280 targets configured)

INFO: Analyzed target //:license-check (169 packages loaded, 11859 targets configured).
[9 / 16] Creating runfiles tree bazel-out/k8-opt-exec-ST-d57f47055a04/bin/external/score_tooling+/dash/tool/formatters/dash_format_converter.runfiles [for tool]; 0s local
[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
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: 228.386s, Critical Path: 2.59s
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]

The created documentation from the pull request is available at: docu-html

[aschemmel-tech]

Need to discuss new work product "user manual" in the process community, incl. what level it is

[aschemmel-tech]

Comments resolved. Found one more point as commented inline.

[PandaeDo]

Fine for me. You might add the versions to the documents as you also have to rebase. Then changes could be easy recognized

[aschemmel-tech]

all my comments now resolved