diff --git a/README.md b/README.md index 7452fab51..1e60cdee9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@

- + + + + Zama Concrete ML +

@@ -254,11 +258,15 @@ This software is distributed under the **BSD-3-Clause-Clear** license. If you ha ## Support - + + + + Support + 🌟 If you find this project helpful or interesting, please consider giving it a star on GitHub! Your support helps to grow the community and motivates further development.

- ↑ Back to top + ↑ Back to top

diff --git a/docs/.gitbook/assets/fundamentals.jpg b/docs/.gitbook/assets/fundamentals.jpg deleted file mode 100644 index 94fba49fc..000000000 Binary files a/docs/.gitbook/assets/fundamentals.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/getstarted1.jpg b/docs/.gitbook/assets/getstarted1.jpg deleted file mode 100644 index 1d9254e0c..000000000 Binary files a/docs/.gitbook/assets/getstarted1.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/getstarted2.jpg b/docs/.gitbook/assets/getstarted2.jpg deleted file mode 100644 index be44c0a04..000000000 Binary files a/docs/.gitbook/assets/getstarted2.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/getstarted3.jpg b/docs/.gitbook/assets/getstarted3.jpg deleted file mode 100644 index bb85f9c83..000000000 Binary files a/docs/.gitbook/assets/getstarted3.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/guides.jpg b/docs/.gitbook/assets/guides.jpg deleted file mode 100644 index 88c9ebd5f..000000000 Binary files a/docs/.gitbook/assets/guides.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/orange1.png b/docs/.gitbook/assets/orange1.png new file mode 100644 index 000000000..7ff77fa96 Binary files /dev/null and b/docs/.gitbook/assets/orange1.png differ diff --git a/docs/.gitbook/assets/orange2.png b/docs/.gitbook/assets/orange2.png new file mode 100644 index 000000000..cee8e2c52 Binary files /dev/null and b/docs/.gitbook/assets/orange2.png differ diff --git a/docs/.gitbook/assets/orange3.png b/docs/.gitbook/assets/orange3.png new file mode 100644 index 000000000..9f5d305d3 Binary files /dev/null and b/docs/.gitbook/assets/orange3.png differ diff --git a/docs/.gitbook/assets/tutorials.jpg b/docs/.gitbook/assets/tutorials.jpg deleted file mode 100644 index 6370df4c5..000000000 Binary files a/docs/.gitbook/assets/tutorials.jpg and /dev/null differ diff --git a/docs/.gitbook/assets/yellow1.png b/docs/.gitbook/assets/yellow1.png new file mode 100644 index 000000000..71007b381 Binary files /dev/null and b/docs/.gitbook/assets/yellow1.png differ diff --git a/docs/.gitbook/assets/yellow2.png b/docs/.gitbook/assets/yellow2.png new file mode 100644 index 000000000..2af0c7d9e Binary files /dev/null and b/docs/.gitbook/assets/yellow2.png differ diff --git a/docs/.gitbook/assets/yellow3.png b/docs/.gitbook/assets/yellow3.png new file mode 100644 index 000000000..fa6754002 Binary files /dev/null and b/docs/.gitbook/assets/yellow3.png differ diff --git a/docs/README.md b/docs/README.md index 99799feff..859001404 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,23 +2,38 @@ description: >- Concrete ML is an open-source, privacy-preserving, machine learning framework based on Fully Homomorphic Encryption (FHE). +layout: + title: + visible: true + description: + visible: true + tableOfContents: + visible: true + outline: + visible: true + pagination: + visible: false --- # Welcome -## Start here +## Get started Learn the basics of Concrete ML, set it up, and make it run with ease. -
What is Concrete MLgetstarted1.jpggetting-started
Installationgetstarted2.jpgpip_installing.md
Key conceptsgetstarted3.jpgconcepts.md
+
What is Concrete MLyellow1.pnggetting-started
Installationyellow2.pngpip_installing.md
Key conceptsyellow3.pngconcepts.md
## Build with Concrete ML Start building with Concrete ML by exploring its core features, discovering essential guides, and learning more with user-friendly tutorials. -
FundamentalsExplore core features and basics of Concrete ML.fundamentals.jpg
GuidesDiscover essential guides to work with Concrete ML.guides.jpg
TutorialsLearn more about Concrete ML with our tutorials.tutorials.jpg
+
FundamentalsExplore core features and basics of Concrete ML.

orange1.png
GuidesDiscover essential guides to work with Concrete ML.

orange2.png
TutorialsLearn more about Concrete ML with our tutorials.

orange3.png
-## References & Explanations +## Explore more + +Access to additional resources and join the Zama community. + +### References & Explanations Refer to the API, review product architecture, and access additional resources for in-depth explanations while working with Concrete ML. @@ -29,14 +44,14 @@ Refer to the API, review product architecture, and access additional resources f - [Advanced features](explanations/advanced_features.md) - [Project architecture](explanations/inner-workings/) -## Supports +### Supports Ask technical questions and discuss with the community. Our team of experts usually answers within 24 hours in working days. -- [Community forum](https://community.zama.ai/) +- [Community forum](https://community.zama.ai/c/concrete-ml/8) - [Discord channel](https://discord.fhe.org/) -## Developers +### Developers Collaborate with us to advance the FHE spaces and drive innovation together. @@ -44,3 +59,7 @@ Collaborate with us to advance the FHE spaces and drive innovation together. - [Check the latest release note](https://github.com/zama-ai/concrete-ml/releases) - [Request a feature](https://github.com/zama-ai/concrete-ml/issues/new?assignees=&labels=feature&projects=&template=feature_request.md) - [Report a bug](https://github.com/zama-ai/concrete-ml/issues/new?assignees=&labels=bug&projects=&template=bug_report.md) + +______________________________________________________________________ + +We value your feedback! [Take a 5-question developer survey](https://zama-project.webflow.io/developer-survey) to improve the Concrete ML library and the documentation and help other developers use FHE. diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 8ae8ddb5d..8e65a0a16 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -110,7 +110,7 @@ - [FHE Op-graph design](explanations/inner-workings/fhe-op-graphs.md) - [External libraries](explanations/inner-workings/external_libraries.md) -## Developer +## Developers - [Set up the project](developer/project_setup.md) - [Set up Docker](developer/docker_setup.md)