diff options
| author | Adam Janovsky | 2022-05-27 07:58:27 +0200 |
|---|---|---|
| committer | Adam Janovsky | 2022-05-27 07:58:27 +0200 |
| commit | 4f63702ac1141c6ea289f0dddf39a6ecba10aefd (patch) | |
| tree | a90563f814b39dbd9b50e1ae48ebac45ac950c02 /docs | |
| parent | 3efa758e95c9279c52047897a8f0964b3cea20e0 (diff) | |
| download | sec-certs-4f63702ac1141c6ea289f0dddf39a6ecba10aefd.tar.gz sec-certs-4f63702ac1141c6ea289f0dddf39a6ecba10aefd.tar.zst sec-certs-4f63702ac1141c6ea289f0dddf39a6ecba10aefd.zip | |
Docs: comment on cc notebook
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.md | 2 | ||||
| -rw-r--r-- | docs/tutorial.md | 3 |
2 files changed, 1 insertions, 4 deletions
diff --git a/docs/index.md b/docs/index.md index 61c39ec5..4760ed1c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ Welcome to the technical documentation of *sec-certs* tool for the data analysis of products certified with Common Criteria or FIPS 140 frameworks. If you're looking for general description of the tool, its use cases and capabilites, we refer you to [sec-certs homepage](https://seccerts.org/). If you are looking for more advanced knowledge, e.g. how to mine your own data, how to extend the tool, and so forth, this is the right place. -There are three main parts of this documentation. *User's guide* describes high-level use of our tool. Driven by this knowledge, you can progress to *Notebook examples* that showcase most of the API that we use in the form of Jupyter notebooks. The documentation currently does not have all modules documented with `autodoc`, so for the API reference, you must directly inspect the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/sec_certs) module. If you want, you can run the notebooks as they are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks). If you are interested in contributing to our project or in other aspects of our development, you can consult the relevant *GitHub artifacts* +There are three main parts of this documentation. *User's guide* describes high-level use of our tool. Driven by this knowledge, you can progress to *Notebook examples* that showcase some of the API that we use in the form of Jupyter notebooks. The documentation also contains some of the modules documented with `autodoc`, see *API reference*. Still, some dark corners of our codebase are not documented. To inspect the code directly, see the [sec_certs](https://github.com/crocs-muni/sec-certs/tree/main/sec_certs) module. If you want, you can run the notebooks as they are stored in the [project repository](https://github.com/crocs-muni/sec-certs/tree/main/notebooks). If you are interested in contributing to our project or in other aspects of our development, you can consult the relevant *GitHub artifacts* ```{button-ref} quickstart :align: center diff --git a/docs/tutorial.md b/docs/tutorial.md deleted file mode 100644 index 47e78870..00000000 --- a/docs/tutorial.md +++ /dev/null @@ -1,3 +0,0 @@ -# Tutorial - -TBA
\ No newline at end of file |