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
License Check Results🚀 The license check job ran with the Bazel command: bazel run --lockfile_mode=error //:license-checkStatus: Click to expand output |
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.
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.