aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorAdam Janovsky2022-05-02 07:59:08 +0200
committerAdam Janovsky2022-05-02 07:59:08 +0200
commit8ec5e35af3d504fa93195cbabff1240e867fb1e6 (patch)
tree0638b25d58f14e0011b4a5ee526ef4aa7c630bfb
parent766164f7534e4d41a1668cc553c51c0ad3c0630f (diff)
downloadsec-certs-8ec5e35af3d504fa93195cbabff1240e867fb1e6.tar.gz
sec-certs-8ec5e35af3d504fa93195cbabff1240e867fb1e6.tar.zst
sec-certs-8ec5e35af3d504fa93195cbabff1240e867fb1e6.zip
declare scope of docs
-rw-r--r--docs/index.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/index.md b/docs/index.md
index 8cd9c8ef..cb819301 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,5 +1,7 @@
# Sec-certs documentation
+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*
```{toctree}