-
Notifications
You must be signed in to change notification settings - Fork 18
Move documentation to right folders and add user manual #97
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
17 commits
Select commit
Hold shift + click to select a range
5fe8af1
move documentation to right folders and add user manual
RolandJentschETAS ae79b7b
fix file name
RolandJentschETAS 4dc8248
fix overview
RolandJentschETAS ae264a9
Merge branch 'main' into improvement_move_documentation_folders
RolandJentschETAS 822151b
fix warning
RolandJentschETAS f8343e8
Add lost folder again
RolandJentschETAS 8abab36
rework structure
RolandJentschETAS 682cac7
add line
RolandJentschETAS 713a4f3
add link to S-CORE main
RolandJentschETAS c5b7d52
move back quickstart
RolandJentschETAS c72109b
move back also internal configuration
RolandJentschETAS 3fbc9dd
add document type
RolandJentschETAS 426abad
fix review finding
RolandJentschETAS 3f6a21d
add link to quickstart
RolandJentschETAS 9597b03
fix review comment
RolandJentschETAS 4e60733
remove double checklist in implementation
RolandJentschETAS ad17c25
fix review finding
RolandJentschETAS File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Large diffs are not rendered by default.
Oops, something went wrong.
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
Empty file.
Empty file.
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -18,5 +18,6 @@ Manuals | |
| .. toctree:: | ||
| :titlesonly: | ||
|
|
||
| user_manual | ||
| safety_manual | ||
| security_manual | ||
Empty file.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| .. | ||
| # ******************************************************************************* | ||
| # Copyright (c) 2026 Contributors to the Eclipse Foundation | ||
| # | ||
| # See the NOTICE file(s) distributed with this work for additional | ||
| # information regarding copyright ownership. | ||
| # | ||
| # This program and the accompanying materials are made available under the | ||
| # terms of the Apache License Version 2.0 which is available at | ||
| # https://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # SPDX-License-Identifier: Apache-2.0 | ||
| # ******************************************************************************* | ||
|
|
||
|
RolandJentschETAS marked this conversation as resolved.
|
||
| .. _user_manual: | ||
|
|
||
| User Manual | ||
| ########### | ||
|
|
||
|
RolandJentschETAS marked this conversation as resolved.
|
||
| .. document:: User Manual <module name> | ||
| :id: doc__user_manual | ||
| :status: draft | ||
| :version: 1 | ||
| :safety: QM | ||
| :security: NO | ||
| :realizes: wp__training_path[version==1] | ||
|
|
||
|
|
||
| .. attention:: | ||
|
RolandJentschETAS marked this conversation as resolved.
|
||
| Update the document metadata according to your needs. | ||
|
|
||
| Overview | ||
| ======== | ||
|
|
||
| This user manual provides comprehensive guidance for using the [Your Module Name] module from an end customer perspective. | ||
| It covers installation, configuration, basic usage, and best practices for integrating this module | ||
| into your project. | ||
|
|
||
| .. note:: | ||
| This is a template user manual. Replace placeholder text with actual module-specific information. | ||
|
|
||
| For build and test of the module itself, please refer to the :ref:`quick-start-building-testing`. | ||
|
|
||
| Environment Needs | ||
| ================= | ||
|
|
||
| Basic needed software environment for the module development and usage: | ||
|
|
||
| * **C++**: C++17 or later | ||
|
RolandJentschETAS marked this conversation as resolved.
|
||
| * **Rust**: 1.70 or later (if Rust support is included) | ||
| * **Build System**: Bazel 6.0 or later | ||
| * **Operating Systems**: Linux, QNX | ||
|
|
||
| Dependencies | ||
|
RolandJentschETAS marked this conversation as resolved.
RolandJentschETAS marked this conversation as resolved.
|
||
| ------------ | ||
|
|
||
| [List key external dependencies, licenses, and version requirements] | ||
|
|
||
| **Example:** | ||
|
|
||
| * Standard library (STL/Core) | ||
| * [Other required libraries] | ||
|
|
||
| See also MODULE.bazel files for more details on dependencies. | ||
|
|
||
| Module Configuration Details | ||
| ============================= | ||
|
|
||
| <A detailed explanation of the module configuration which can be done by end users, including the purpose and effects of the settings might be explained in the files in the config subdirectory.> | ||
|
|
||
| Configuration Effects | ||
| --------------------- | ||
|
|
||
| <Explain how the configuration settings affect the module's behavior, performance, and integration with other components. Include examples of typical configurations and their outcomes.> | ||
|
|
||
|
|
||
| Examples | ||
| ======== | ||
|
|
||
| <Useful examples and tutorials should be provided in the ``examples/`` directory. Link to specific examples here.> | ||
|
|
||
| API Reference | ||
| ============= | ||
|
|
||
| For complete and detailed API documentation and descriptions, refer to the API documentation in the ``api_description/`` directory. | ||
|
|
||
| Performance Considerations | ||
| ========================== | ||
|
|
||
| This section covers performance characteristics, optimization strategies, and resource requirements. | ||
| Refer to the ``performance/`` directory for detailed performance guides and benchmarks. | ||
|
|
||
| Integration Guidelines | ||
| ====================== | ||
|
|
||
| Integrating with Your Project | ||
| ------------------------------ | ||
|
|
||
| 1. Add the module to your Bazel workspace: | ||
|
RolandJentschETAS marked this conversation as resolved.
|
||
|
|
||
| .. code-block:: python | ||
|
|
||
| # In your MODULE.bazel | ||
| bazel_dep(name = "module_template", version = "1.0") | ||
|
|
||
| 2. Reference in your build files: | ||
|
|
||
| .. code-block:: python | ||
|
|
||
| cc_library( | ||
| name = "my_target", | ||
| deps = ["@module_template//score/component_example:component"], | ||
| ) | ||
|
|
||
| 3. Include headers and compile your code | ||
|
PandaeDo marked this conversation as resolved.
|
||
|
|
||
|
|
||
| Version History, Compatibility, and Troubleshooting | ||
| =================================================== | ||
|
|
||
| For comprehensive information on the following topics, refer to :doc:`/docs/release/release_note`: | ||
|
|
||
| * Version history and changes | ||
| * Compatibility notes and upgrade instructions | ||
| * Known issues and limitations | ||
| * Troubleshooting tips and solutions | ||
| * Security vulnerabilities (CVEs) | ||
|
|
||
| Safety and Security | ||
| =================== | ||
|
|
||
| **Safety-Critical Usage**: If you are using this module in a safety-critical context, | ||
| please refer to :doc:`safety_manual` for detailed safety requirements and guidelines. | ||
|
|
||
| **Security Considerations**: For information about security aspects and requirements, | ||
| please refer to :doc:`security_manual`. | ||
|
|
||
| License | ||
| ======= | ||
|
|
||
| This module is licensed under the Apache License Version 2.0. | ||
| See the LICENSE file in the repository for full license text. | ||
|
|
||
| Feedback and Contributions | ||
| ========================== | ||
|
|
||
| Your feedback and contributions are welcome! Please report issues or suggestions through the | ||
| project's issue tracker or contribute directly to the repository. | ||
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.