doc: let's agree on a plan

closes #305

.github/ISSUE_TEMPLATE/refactor.md

@@ -16,4 +16,4 @@ List all files/modules/projects impacted by this refactor.
 <p>
 file.py
 </p>
-</details>
+</details>

README.md

@@ -2,7 +2,7 @@
 
 Concrete Framework Python API - collection of tools to FHE all the things
 
-## Installing 
+## Installing
 
 Installation steps are described in [INSTALLING.md](docs/install/INSTALLING.md).
 

docs/README.md

@@ -0,0 +1,3 @@
+# What is ConcreteFHE
+
+To be done

docs/dev/explanation/COMPILATION.md

@@ -54,7 +54,7 @@ Once the MLIR is prepared, the rest of the stack, which you can learn more about
 
 Here is the visual representation of the pipeline:
 
-![Frontend Flow](../_static/compilation-pipeline/frontend_flow.svg)
+![Frontend Flow](../../_static/compilation-pipeline/frontend_flow.svg)
 
 ## Tracing
 
@@ -67,7 +67,7 @@ def f(x):
 
 the goal of tracing is to create the following operation graph without needing any change from the user.
 
-![](../_static/compilation-pipeline/two_x_plus_three.png)
+![](../../_static/compilation-pipeline/two_x_plus_three.png)
 
 (Note that the edge labels are for non-commutative operations. To give an example, a subtraction node represents `(predecessor with edge label 0) - (predecessor with edge label 1)`)
 
@@ -140,7 +140,7 @@ After the entire dataset is evaluated, we assign a data type to each node using
 
 Here is an example, given this operation graph where `x` is encrypted:
 
-![](../_static/compilation-pipeline/two_x_plus_three.png)
+![](../../_static/compilation-pipeline/two_x_plus_three.png)
 
 and this dataset:
 
@@ -218,7 +218,7 @@ x = EncryptedScalar(UnsignedInteger(2))
 
 #### Corresponding Operation Graph
 
-![](../_static/compilation-pipeline/two_x_plus_three.png)
+![](../../_static/compilation-pipeline/two_x_plus_three.png)
 
 ### Topological Transforms
 
@@ -268,7 +268,7 @@ y = EncryptedScalar(UnsignedInteger(1))
 
 #### Corresponding Operation Graph
 
-![](../_static/compilation-pipeline/forty_two_minus_x_plus_y_times_two.png)
+![](../../_static/compilation-pipeline/forty_two_minus_x_plus_y_times_two.png)
 
 ### Topological Transforms
 

docs/dev/explanation/FLOAT-FUSING.md

@@ -24,15 +24,15 @@ Any computation where there is a single variable integer input and a single inte
 
 The `quantized_sin` graph of operations:
 
-![](../_static/float_fusing_example/before.png)
+![](../../_static/float_fusing_example/before.png)
 
 The float subgraph that was detected:
 
-![](../_static/float_fusing_example/subgraph.png)
+![](../../_static/float_fusing_example/subgraph.png)
 
 The simplified graph of operations with the float subgraph condensed in an `ArbitraryFunction` node:
 
-![](../_static/float_fusing_example/after.png)
+![](../../_static/float_fusing_example/after.png)
 
 ## How is it done in concretefhe?
 

docs/dev/explanation/MLIR.md

@@ -0,0 +1,4 @@
+# MLIR
+
+to be done
+

docs/dev/howto/CONTRIBUTING.md

@@ -95,7 +95,7 @@ git checkout $YOUR_BRANCH
 # rebase on top of main branch
 git rebase main
 
-# push the latest version of the local branch to remote 
+# push the latest version of the local branch to remote
 git push --force
 ```
 

docs/index.rst

@@ -4,30 +4,60 @@ Homomorphic Development Kit's documentation
 
 .. toctree::
    :maxdepth: 2
-   :caption: Installing
+   :caption: Basics
 
+   README.md
    install/INSTALLING.md
    install/DOCKER.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: User doc
+   :caption: Tutorial
 
-   user/FIRST_USE.md
+   user/tutorial/FIRST_TUTORIAL.md
+   user/tutorial/SECOND_TUTORIAL.md
+   user/tutorial/THIRD_TUTORIAL.md
 
 .. toctree::
    :maxdepth: 2
-   :caption: Developer doc
+   :caption: How to
 
-   dev/TERMINOLOGY_AND_STRUCTURE.md
-   dev/COMPILATION.md
-   dev/FLOAT-FUSING.md
-   dev/DOCUMENTING.md
-   dev/CONTRIBUTING.md
-   dev/RELEASING.md
+   user/howto/COMPILE.md
+   user/howto/REDUCE_NEEDED_PRECISION.md
+   user/howto/DEBUG.md
+   user/howto/SUBMIT_ISSUE.md
+   user/howto/SUPPORT.md
+   user/howto/FAQ.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Explanation
+
+   user/explanation/WHAT_IS_FHE.md
+   user/explanation/FHE_LIMITS.md
+   user/explanation/QUANTIZATION.md
+   user/explanation/FUTURE_FEATURES.md
 
 .. toctree::
    :maxdepth: 5
-   :caption: Docs from sources
+   :caption: Reference
 
-   _apidoc/modules.rst
+   API <_apidoc/modules.rst>
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developper - How To
+
+   dev/howto/DOCUMENTING.md
+   Releasing on GitHub <dev/howto/RELEASING.md>
+   dev/howto/CONTRIBUTING.md
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developper - Explanation
+
+   dev/explanation/COMPILATION.md
+   dev/explanation/TERMINOLOGY_AND_STRUCTURE.md
+   dev/explanation/FLOAT-FUSING.md
+   dev/explanation/MLIR.md
+   

docs/user/FIRST_USE.md

@@ -1,3 +0,0 @@
-# First Use
-
-To be continued

docs/user/explanation/FHE_LIMITS.md

@@ -0,0 +1,2 @@
+# FHE Limits
+

docs/user/explanation/FUTURE_FEATURES.md

@@ -0,0 +1,2 @@
+# Future Features
+

docs/user/explanation/QUANTIZATION.md

@@ -0,0 +1,2 @@
+# Quantization
+

docs/user/explanation/WHAT_IS_FHE.md

@@ -0,0 +1 @@
+# What is FHE?

docs/user/howto/COMPILE.md

@@ -0,0 +1 @@
+# Compiling

docs/user/howto/DEBUG.md

@@ -0,0 +1 @@
+# Debugging

docs/user/howto/FAQ.md

@@ -0,0 +1,3 @@
+# FAQ
+
+to be done

docs/user/howto/REDUCE_NEEDED_PRECISION.md

@@ -0,0 +1 @@
+# Having a Function Which Requires Less Precision

docs/user/howto/SUBMIT_ISSUE.md

@@ -0,0 +1 @@
+# Submitting Issues

docs/user/howto/SUPPORT.md

@@ -0,0 +1 @@
+# Support

docs/user/tutorial/FIRST_TUTORIAL.md

@@ -0,0 +1,3 @@
+# First Tutorial
+
+To be continued

docs/user/tutorial/SECOND_TUTORIAL.md

@@ -0,0 +1,3 @@
+# Second Tutorial
+
+To be continued

docs/user/tutorial/THIRD_TUTORIAL.md

@@ -0,0 +1,3 @@
+# Third Tutorial
+
+To be continued