From 5bc0ff42e1cb2cd6cdfe8db2cbfef158d8f45290 Mon Sep 17 00:00:00 2001 From: aquint-zama Date: Mon, 11 Jul 2022 12:22:43 +0200 Subject: [PATCH] docs: last update from Gitbook --- Makefile | 4 ++-- README.md | 2 +- docs/README.md | 6 ++---- docs/SUMMARY.md | 8 ++++---- docs/{basics => getting-started}/compatibility.md | 0 docs/{basics => getting-started}/installing.md | 0 docs/{basics => getting-started}/quick_start.md | 0 7 files changed, 9 insertions(+), 11 deletions(-) rename docs/{basics => getting-started}/compatibility.md (100%) rename docs/{basics => getting-started}/installing.md (100%) rename docs/{basics => getting-started}/quick_start.md (100%) diff --git a/Makefile b/Makefile index 6f73b877f..f241c58f3 100644 --- a/Makefile +++ b/Makefile @@ -267,11 +267,11 @@ todo: .PHONY: supported_functions # Update docs with supported functions supported_functions: - poetry run python script/doc_utils/gen_supported_ufuncs.py docs/basics/compatibility.md + poetry run python script/doc_utils/gen_supported_ufuncs.py docs/getting-started/compatibility.md .PHONY: check_supported_functions # Check supported functions (for the doc) check_supported_functions: - poetry run python script/doc_utils/gen_supported_ufuncs.py docs/basics/compatibility.md --check + poetry run python script/doc_utils/gen_supported_ufuncs.py docs/getting-started/compatibility.md --check .PHONY: licenses # Generate the list of licenses of dependencies licenses: diff --git a/README.md b/README.md index a09642079..cf2df066f 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ You can get the concrete-numpy docker image by pulling the latest docker image: docker pull zamafhe/concrete-numpy:v0.6.0 ``` -You can find more detailed installation instructions in [installing.md](docs/basics/installing.md) +You can find more detailed installation instructions in [installing.md](docs/getting-started/installing.md) ## Getting started diff --git a/docs/README.md b/docs/README.md index 17e8c5985..995f4617b 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,7 @@ -# Introduction +# What is Concrete Numpy? [⭐️ Star the repo on Github](https://github.com/zama-ai/concrete-numpy) | 🗣 [Community support forum](https://community.zama.ai/c/concrete-numpy) | 📁 [Contribute to the project](dev/contributing.md) -## Welcome to Concrete Numpy! - ![](\_static/zama\_home\_docs.jpeg) **Concrete Numpy** is an open-source library which simplifies the use of fully homomorphic encryption (FHE). @@ -21,6 +19,6 @@ This documentation is split into several sections: * **How to** section to help you perform specific tasks * **Developer** section to explain the inner workings of the library and everything related to contributing to the project -## Looking for support? Join our community! +## Looking for support? Ask our team! ![](\_static/zama\_support\_docs.jpeg) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 45577f40b..77b5e17fc 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -1,12 +1,12 @@ # Table of contents -* [Introduction](README.md) +* [What is Concrete Numpy?](README.md) ## Getting Started -* [Installation](basics/installing.md) -* [Quick start](basics/quick\_start.md) -* [Compatibility](basics/compatibility.md) +* [Installation](getting-started/installing.md) +* [Quick start](getting-started/quick\_start.md) +* [Compatibility](getting-started/compatibility.md) ## Tutorials diff --git a/docs/basics/compatibility.md b/docs/getting-started/compatibility.md similarity index 100% rename from docs/basics/compatibility.md rename to docs/getting-started/compatibility.md diff --git a/docs/basics/installing.md b/docs/getting-started/installing.md similarity index 100% rename from docs/basics/installing.md rename to docs/getting-started/installing.md diff --git a/docs/basics/quick_start.md b/docs/getting-started/quick_start.md similarity index 100% rename from docs/basics/quick_start.md rename to docs/getting-started/quick_start.md