diff --git a/README.rst b/README.rst index 9a847edbb7975ceb4775dc15a5af125a83c687af..94bd9cad97091bd24a846bc72c4ac95e56a100d7 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ PrivateStorageio ================ -The backend for a private, secure, and end-to-end encrypted storage solution +The backend for a private, secure, and end-to-end encrypted storage solution. Building -------- @@ -14,6 +14,12 @@ Start by setting up the development/operations environment:: Documentation ~~~~~~~~~~~~~ +There is documentation for: + +* Users: ``docs/user/README.rst`` +* Operators/Admins: ``docs/ops/README.rst`` +* Developers: ``docs/dev/README.rst`` + The documentation can be built using this command:: $ nix-build docs.nix diff --git a/docs/source/dev/README.rst b/docs/source/dev/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..5550b7c3ec3e4c5fad98a503244da21e44d5686b --- /dev/null +++ b/docs/source/dev/README.rst @@ -0,0 +1,4 @@ +Development documentation +========================= + +This contains development documentation. diff --git a/docs/source/index.rst b/docs/source/index.rst index 8cc638a205fcdf6723cf0d48ca4e258dadb00fce..361fc01bf2a87463ad54a6bdfb7e771ac54f7804 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -13,6 +13,9 @@ Welcome to PrivateStorageio's documentation! README architecture-overview morph + user/README + ops/README + dev/README diff --git a/docs/source/ops/README.rst b/docs/source/ops/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..27195d3574dd18c2a3398555d6b8ec258e0e5402 --- /dev/null +++ b/docs/source/ops/README.rst @@ -0,0 +1,4 @@ +Deployment documentation +======================== + +This contains documentation regarding running PrivateStorageIo. diff --git a/docs/source/user/README.rst b/docs/source/user/README.rst new file mode 100644 index 0000000000000000000000000000000000000000..7c2dfdc1360ed7ee6c478ad52c4d6af0680daa30 --- /dev/null +++ b/docs/source/user/README.rst @@ -0,0 +1,4 @@ +User documentation +================== + +This contains user documentation.