Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion MODULE.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ bazel_dep(name = "buildifier_prebuilt", version = "8.5.1.2", dev_dependency = Tr

#docs-as-code
bazel_dep(name = "score_docs_as_code", version = "4.5.0", dev_dependency = True)
bazel_dep(name = "score_process", version = "1.5.4", dev_dependency = True)
bazel_dep(name = "score_process", version = "1.6.0", dev_dependency = True)

# grpc-java 1.66.0 imports a grpc extension repo removed in newer grpc versions.
# Force a compatible grpc-java version until upstream dependencies converge.
Expand Down
70 changes: 0 additions & 70 deletions MODULE.bazel.lock

Large diffs are not rendered by default.

59 changes: 11 additions & 48 deletions docs/features/feature_example/architecture/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,12 @@ Mandatory: A motivation for the decomposition
Static Architecture
-------------------

The live feature architecture template snippets are maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`__.
<The static architecture of the feature can be described here. It includes the feature architecture diagrams and some descriptions.>

.. note::
The Architecture can be split into multiple files, it is an high level architecture design
which can be shown without actual c++/rust interfaces and data types
and there will be link to internal architecture till code to get actual api descriptions.

.. code-block:: rst

Expand All @@ -84,6 +88,8 @@ The live feature architecture template snippets are maintained in the
Dynamic Architecture
--------------------

<The dynamic architecture of the feature can be described here. That can include sequence diagrams, state machines, and other dynamic views of the feature.>

.. code-block:: rst

.. feat_arc_dyn:: Dynamic View
Expand All @@ -101,54 +107,11 @@ Logical Interfaces

The logical interfaces of the feature are defined in the `logical interfaces` section of the feature documentation in the project repository.

Module Viewpoint
----------------

The following modules are needed to be defined to be able to draw the static feature view.
They will be replaced by linking the proper module definitions in the used module's repositories as soon as those exist.

The rendered module and used-component examples are maintained in the
`module template documentation <https://eclipse-score.github.io/module_template/main/>`_.

.. code-block:: rst

.. mod:: Module Name
:id: mod__module_name
:includes: comp__component_name_template


.. mod_view_sta:: Module Name Static View
:id: mod_view_sta__feature_name__module_name
:includes: comp__component_name_template

.. needarch::
:scale: 50
:align: center

{{ draw_module(need(), needs) }}
See `SCORE Features <https://eclipse-score.github.io/score/main/features/index.html>`_ for more information.

Used Components
---------------

The following components are needed to be defined to be able to draw the static feature view.
They will be replaced by linking the proper SW component definitions in the used module's repositories as soon as those exist.

.. code-block:: rst

.. comp:: Component Name
:id: comp__component_name_template
:safety: ASIL_B
:security: YES
:status: invalid
:implements: logic_arc_int__feature_name__interface_name1

.. note::
Architecture can be split into multiple files, it is an high level architecture design
which can be shown without actual c++/rust interfaces and data types
and there will be link to internal architecture till code to get actual api descriptions.

.. attention::
The above directives must be updated according to your feature architecture.
The components used by the feature are defined in the `components` section of the module documentation.

- Replace the example content by the real content (according to :need:`gd_guidl__arch_design`)
- Set the status to valid and start the review/merge process
See :ref:`component_template` for an example component.
Empty file.
Empty file added docs/manuals/config/.gitkeep
Empty file.
Empty file.
1 change: 1 addition & 0 deletions docs/manuals/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,6 @@ Manuals
.. toctree::
:titlesonly:

user_manual
safety_manual
security_manual
Empty file.
148 changes: 148 additions & 0 deletions docs/manuals/user_manual.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
..

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@RolandJentschETAS RolandJentschETAS Jun 22, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

# *******************************************************************************
# 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
# *******************************************************************************

Comment thread
RolandJentschETAS marked this conversation as resolved.
.. _user_manual:

User Manual
###########

Comment thread
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::
Comment thread
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
Comment thread
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
Comment thread
RolandJentschETAS marked this conversation as resolved.
Comment thread
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:
Comment thread
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

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stop reading here. Same as above. I don't think we need this additional document.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See changed content now please.



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.
Loading
Loading