Skip to content

Commit

Permalink
docs: update SPLE glossary with latest workshop outcome
Browse files Browse the repository at this point in the history
  • Loading branch information
xxthunder committed Apr 16, 2024
1 parent 169fe80 commit 3f9f05c
Show file tree
Hide file tree
Showing 11 changed files with 583 additions and 169 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -157,3 +157,6 @@ dmypy.json

# Cython debug symbols
cython_debug/

# Draw.io backup files
*.drawio.bkp
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# See https://pre-commit.com for more information
# See https://pre-commit.com/hooks.html for more hooks
exclude: "CHANGELOG.md|.copier-answers.yml|.all-contributorsrc|.vscode/.*|src/spl_core/project_creator/templates/.*"
exclude: "CHANGELOG\\.md|\\.copier-answers\\.yml|\\.all-contributorsrc|\\.vscode/.*|.*\\.svg|src/spl_core/project_creator/templates/.*"
default_stages: [commit]

ci:
Expand Down
3 changes: 2 additions & 1 deletion .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"cSpell.words": [
"cookiecutter",
"kconfig",
"kconfiglib"
"kconfiglib",
"SPLE"
]
}
36 changes: 18 additions & 18 deletions docs/features/index.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
✨ Features
************

Component Report
----------------

To support the :ref:`component <what_is_a_component>` development, SPL Core provides features to:

- document the component behavior - see :ref:`How to create a component detail design <how_to_component_detail_design>`
- test the component behavior - see :ref:`How to create a component test cases <how_to_component_test_cases>`
- generate component report with full traceability between documentation, code and tests - see :ref:`Component relevant CMake Targets <component_cmake_targets>`


Variant Report
--------------

To support the :ref:`variant <what_is_a_variant>` development, SPL Core provides features to:

✨ Features
************

Component Report
----------------

To support the :ref:`component <glossary_component>` development, SPL Core provides features to:

- document the component behavior - see :ref:`How to create a component detail design <how_to_component_detail_design>`
- test the component behavior - see :ref:`How to create a component test cases <how_to_component_test_cases>`
- generate component report with full traceability between documentation, code and tests - see :ref:`Component relevant CMake Targets <component_cmake_targets>`


Variant Report
--------------

To support the :ref:`variant <glossary_variant>` development, SPL Core provides features to:

TODO: add variant report description
Loading

0 comments on commit 3f9f05c

Please sign in to comment.