You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit was created on GitHub.com and signed with GitHub’s verified signature.
Reorganize docs to prepare automatic pdf doc build (#50)
# Changes
- Reorganize docs so that a pdf version can be generated with pandoc
- Add a script to build this pdf
- Add a gh action to build and upload a pdf as an asset on tag creation
# Dependencies:
none
# Tests results
n.a.
# Developer Checklist:
- [x] Test: Changes are tested
- [x] Doc: Documentation has been updated
- [x] Git: Informative git commit message(s)
- [x] Issue: If a related GitHub issue exists, linking is done
## Checklists for documentation
- [x] Grammar: the content is grammatically correct
(spelling, grammar, formatting, US English is used)
- [x] Comprehensibility/Unambiguousness: the content is easy readable,
clear to understand
- [x] Correctness and consistency: the content is technically correct
and consistent,
no contradictions, no double descriptions
- [x] Terminology: technical terms are clear and they are used correctly
and documented in the glossary
- [x] Level of detail: the content matches the detail level necessary
for the reviewed object
# Reviewer checklist:
- [x] Review: Changes are reviewed
- [x] Review: Tested by the reviewer
## Checklists for documentation
- [x] Grammar: the content is grammatically correct
(spelling, grammar, formatting, US English is used)
- [x] Comprehensibility/Unambiguousness: the content is easy readable,
clear to understand
- [x] Correctness and consistency: the content is technically correct
and consistent,
no contradictions, no double descriptions
- [x] Terminology: technical terms are clear and they are used correctly
and documented in the glossary
- [x] Level of detail: the content matches the detail level necessary
for the reviewed object
---------
Signed-off-by: Simone Weiss <simone.weiss@elektrobit.com>
Signed-off-by: simone-weiss <simone.weiss@elektrobit.com>
Co-authored-by: Thomas Irgang (thir820) <thomas.irgang@elekrobit.com>