Skip to content

Commit

Permalink
extend docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hofbi committed Feb 28, 2022
1 parent c92b5f7 commit 2a3b9f1
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ jobs:
mv artifacts-docs/* public
mkdir -p public/coverage
mv artifacts-cpp public/coverage/cpp
mv artifacts-python/ public/coverage/python
mv artifacts-python public/coverage/python
mkdir -p public/export
make package
mv export/*.zip public/export
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,4 @@ package: clean_export
$(call export_runner,source/example,example)

solution_package: clean_export
$(call export_runner,source/example -k,example)
$(call export_runner,source/example -k,example_solution)
19 changes: 19 additions & 0 deletions docs/chapter/documentation.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
= Documentation

This documents all important information required for maintaining this course.

== Setup

Find the setup instruction in the project landing page under {url-repo}#development[Development]

== Tools

We use several tools to automatically maintain and manage repeating processes in this lab.
Details can be found in the {url-tools}[Tools].

== Code Coverage

Code coverage for the C++ and Python tooling code.

* link:coverage/cpp[Coverage C++]
* link:coverage/python[Coverage Python]
2 changes: 2 additions & 0 deletions docs/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ Markus Hofbauer

include::chapter/materials.adoc[]

include::chapter/documentation.adoc[]

:leveloffset: -1

0 comments on commit 2a3b9f1

Please sign in to comment.