docs: updating the doc a bit

refs #1050

docs/dev/explanation/COMPILATION.md

@@ -1,3 +1,9 @@
+
+```{warning}
+FIXME(umut): update with the new API
+```
+
+
 # Compilation Pipeline In Depth
 
 ## What is **concretefhe**?
@@ -54,6 +60,10 @@ Once the MLIR is prepared, the rest of the stack, which you can learn more about
 
 Here is the visual representation of the pipeline:
 
+```{warning}
+FIXME(arthur): check the graph, update with what is missing, notably: torch to numpy, quantization. Maybe an independant graph for quantization may be clearer.
+```
+
 ![Frontend Flow](../../_static/compilation-pipeline/frontend_flow.svg)
 
 ## Tracing

docs/dev/explanation/FLOAT-FUSING.md

@@ -1,3 +1,7 @@
+```{warning}
+FIXME(Arthur): explain recent updates on the fusing
+```
+
 # Fusing Floating Point Operations
 
 ## Why is it needed?

docs/dev/explanation/QUANTIZATION.md

@@ -0,0 +1,8 @@
+```{warning}
+FIXME(Jordan/Andrei): do this
+```
+
+# Quantization in Depth
+
+(as a researcher)
+

docs/dev/explanation/TERMINOLOGY_AND_STRUCTURE.md

@@ -1,3 +1,7 @@
+```{warning}
+FIXME(Benoit): to check this is still valid
+```
+
 # Terminology and Structure
 
 ## Terminology

docs/dev/howto/CONTRIBUTING.md

@@ -1,6 +1,10 @@
 
 # Contributing
 
+```{warning}
+FIXME(alex): to see if something here needs some update
+```
+
 ```{important}
 There are two ways to contribute to **concretefhe**:
 - you can open issues to report bugs, typos and suggest ideas
@@ -51,6 +55,10 @@ The last requirement is to make sure you get a hundred percent code coverage. Yo
 make coverage
 ```
 
+```{warning}
+FIXME(arthur): is this still valid? (that `make pytest` will not return an error)
+```
+
 Remark that only calling `make pytest` will give you information about the coverage, at the end of the execution, but the test will not return a failure if the coverage is not a hundred percent, as opposed to a call to `make coverage`.
 
 Note that this will compare the coverage with `origin/main`. If you want to set a custom base branch, you can specify `BB` environment variable like so `BB=$YOUR_BASE_BRANCH make coverage`.
@@ -73,7 +81,7 @@ git commit -m "feat(debugging): add an helper function to draw intermediate repr
 git commit -m "fix(tracing): fix a bug that crashed pytorch tracer"
 ```
 
-To learn more about conventional commits, check [this](https://www.conventionalcommits.org/en/v1.0.0/) page.
+To learn more about conventional commits, check [this](https://www.conventionalcommits.org/en/v1.0.0/) page. Remark that commit messages are checked in the comformance step, and rejected if they don't follow the rules.
 
 ## Before creating pull request
 

docs/dev/howto/DOCKER.md

@@ -1,3 +1,10 @@
+```{warning}
+FIXME(arthur): to update if needed
+```
+```{warning}
+FIXME(arthur): to add a new .md about pypy if needed
+```
+
 # Docker
 
 ## Setting up docker and X forwarding

docs/dev/howto/PROJECT_SETUP.md

@@ -1,3 +1,6 @@
+```{warning}
+FIXME(Arthur): to check what needs to be updated here
+```
 
 # Project Setup
 

docs/dev/howto/RELEASING.md

@@ -1,3 +1,7 @@
+```{warning}
+FIXME(arthur): to update with the new workflow
+```
+
 # Creating A Release On GitHub
 
 ## Release Candidate cycle

docs/dev/index.rst

@@ -19,3 +19,4 @@ Developer Guide
    explanation/TERMINOLOGY_AND_STRUCTURE.md
    explanation/FLOAT-FUSING.md
    explanation/MLIR.md
+   explanation/QUANTIZATION.md