docs: update the docs to fhevm06 #612

poppyseedDev · 2024-11-21T13:24:36Z

Closes #531
Closes #523
Closes #529
Closes #533
Closes #497
Closes #527
Closes #528
Closes #243
Closes #521
Closes #520
To discuss #522

This PR significantly improves the developer documentation to make it more developer-friendly by addressing gaps, adding clarity, and enhancing usability. The following changes have been introduced:

Key Improvements

Developer-Focused Enhancements: Concepts that were previously unexplained are now clarified.
Reorganization: Sections have been rearranged for better flow and readability.
Visual Aids: Diagrams are added to simplify complex ideas.
Expanded Examples: New and updated code examples are provided to illustrate key concepts.

Section Updates

Welcome to fhEVM

No changes.

Getting Started

Quick Overview:
- Key concepts and features are now consolidated here for easier access.
- The list of repositories has been moved to this section.
- Includes a reference to the whitepaper (pending an update).
Get Started:
- DevNet details have been streamlined and replaced with Ethereum deployment instructions.
Create a Smart Contract:
- Updated the Hardhat guide to ensure compatibility with fhEVM v0.6.
- Formatting improvements.

Fundamentals

Focuses on explaining core concepts and critical features with clear explanations and examples.

Architecture Overview:
- Provides a high-level understanding of fhEVM architecture.
- No code examples, focusing instead on concepts.
Encryption, Decryption, Re-encryption, and Computation:
- Explains these fundamental concepts with accompanying diagrams for better understanding.
Access Control List (ACL):
- High-level overview without detailed code.

Configuration

Practical guidance on setting up and configuring smart contracts for encrypted operations.

First Smart Contract:
- Includes a simple counter contract example with detailed explanations.
Supported Types:
- Lists all supported encrypted types.
Operations on Encrypted Types:
- Detailed documentation of all supported operations on encrypted types.
Encryption:
- Encrypted input implementation with a code example.
Decryption:
- Provides a code example for decryption.
Decryption in Depth:
- Explains advanced considerations and edge cases for decryption.
Re-encryption:
- Includes code examples demonstrating re-encryption workflows.
ACL Examples:
- Detailed ACL implementations and use cases with code examples.

Guides

Focuses on supplemental concepts and best practices for smart contract development.

Smart Contracts:
- Topics include common pitfalls, conditional statements, FHE branching, random number generation, gas estimation, and error handling.
Frontend:
- Covers frontend-related topics, including application building, Node.js integration, CLI usage, and handling common Webpack errors.

Tutorials

See All Tutorials:
- Provides a centralized list of tutorials.

References

Smart Contracts - fhEVM API:
- Updated for the latest version.
Frontend - fhevmjs Library:
- No updates yet.

Developer

Contributing:
- Added a link to the bounty program.
Development Roadmap:
- Updated to reflect the latest milestones.
Feature Request and Bug Report:
- Links updated for improved usability.
Release Notes:
- Unchanged.

Future TODOs

Update the whitepaper to the latest version.
Expand deployment instructions for Sepolia.
Upgrade the Remix guide to match the latest version.
Update the frontend development section.

docs/fundamentals/first_step/acl_examples.md

docs/fundamentals/first_step/configure.md

docs/guides/gas.md

docs/getting_started/ethereum.md

docs/getting_started/repositories.md

PacificYield · 2024-11-25T10:21:48Z

docs/fundamentals/acl.md

-To simplify matters, a number of functions automatically generate temporary access (using `TFHE.allowTransient` under the hood) for the contract that calls the function. This applies to:
+- **`allow`**: Grants permanent access to an address.
+- **`allowThis`**: Grants the current contract access to manipulate the ciphertext.
+- **`allowTransient`**: Grants temporary access to an address for the current transaction.


It might be useful to link to the explanation of what is transient storage https://eips.ethereum.org/EIPS/eip-1153

It's mentioned a bit above (line 41)

| Transient | Temporary access during a transaction. | Transient storage (EIP-1153) | Calling external functions or computations with ciphertexts. Use when wanting to save on gas costs. |

PacificYield · 2024-11-25T10:23:26Z

docs/fundamentals/architecture_overview.md

+
+---
+
+In the next section, we will dive deeper into encryption, re-encryption, and decryption processes, including how they interact with the KMS and Gateway services. For more details, see [Decrypt and re-encrypt](./d_re_ecrypt_compute.md).


Isn't this link broken?

shouldn't be

docs/fundamentals/first_step/configure.md

docs/guides/error_handling.md

docs/tutorials/see-all-tutorials.md

immortal-tofu · 2024-11-25T13:30:24Z

Regarding whitepaper, we agree on keeping the previous whitepaper and adding fhevm-whitepaper-v2.pdf next to it

docs/fundamentals/first_step/configure.md

PacificYield · 2024-11-27T10:59:05Z

docs/SUMMARY.md

+- [Quick overview](getting_started/overview.md)
+  - [Key concepts and features](getting_started/key_concepts.md)
+  - [Repositories](getting_started/repositories.md)
+  - [Whitepaper](https://github.com/zama-ai/fhevm/blob/main/fhevm-whitepaper.pdf)


We should remove all absolute references for pages/files.

SUMMARY.md is a bit weird, these are actually relative links, but they are written in such a way, because this represents the sidebar of Gitbook. Gitbook has sometimes some compatibility issues with Markdown, but I think this should work.

immortal-tofu · 2024-11-28T15:06:21Z

Run npm run prettier to fix prettier issue (and install prettier in VSCode ;))

poppyseedDev · 2024-11-28T16:13:06Z

@yuxizama ready for your review :)

docs/getting_started/ethereum.md

docs: update readme

poppyseedDev added 4 commits November 20, 2024 18:10

docs: change for fhevm06

2c420ef

docs: restructure, concepts explained

8c90886

docs: update tutorials

ef7edf2

docs: improves API and decryption

425a339

poppyseedDev marked this pull request as ready for review November 22, 2024 18:32

docs: improved some sections checked broken links

4a0bf27

PacificYield mentioned this pull request Nov 25, 2024

ci: updates lintchecker.yml #615

Closed

docs: fix one dead link

7ede0c7

poppyseedDev requested review from immortal-tofu, yuxizama and PacificYield November 25, 2024 09:22

docs: fix one dead link

bfb34e6

immortal-tofu reviewed Nov 25, 2024

View reviewed changes

PacificYield reviewed Nov 25, 2024

View reviewed changes

poppyseedDev changed the title ~~Update the docs to fhevm06~~ docs: update the docs to fhevm06 Nov 25, 2024

docs: prettier and adressing some changes

5668f1d

PacificYield reviewed Nov 26, 2024

View reviewed changes

docs/fundamentals/first_step/configure.md Outdated Show resolved Hide resolved

PacificYield reviewed Nov 27, 2024

View reviewed changes

docs: add review

713a5e1

immortal-tofu approved these changes Nov 28, 2024

View reviewed changes

poppyseedDev added 2 commits November 28, 2024 16:58

docs: fix instances

dc0f419

docs: mini change

8d01c55

poppyseedDev commented Nov 28, 2024

View reviewed changes

docs/getting_started/ethereum.md Show resolved Hide resolved

immortal-tofu added 2 commits November 28, 2024 17:41

docs: update readme

8860bf5

Merge pull request #625 from zama-ai/docs/fix-readme

411816c

docs: update readme

PacificYield approved these changes Nov 29, 2024

View reviewed changes

Merge branch 'main' of github.com:zama-ai/fhevm into fhevm06docs

8be84e4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: update the docs to fhevm06 #612

docs: update the docs to fhevm06 #612

poppyseedDev commented Nov 21, 2024 •

edited

Loading

PacificYield Nov 25, 2024

poppyseedDev Nov 25, 2024

PacificYield Nov 25, 2024

poppyseedDev Nov 25, 2024

immortal-tofu commented Nov 25, 2024

PacificYield Nov 27, 2024

poppyseedDev Nov 28, 2024 •

edited

Loading

immortal-tofu commented Nov 28, 2024

poppyseedDev commented Nov 28, 2024


		---

		In the next section, we will dive deeper into encryption, re-encryption, and decryption processes, including how they interact with the KMS and Gateway services. For more details, see [Decrypt and re-encrypt](./d_re_ecrypt_compute.md).

docs: update the docs to fhevm06 #612

Are you sure you want to change the base?

docs: update the docs to fhevm06 #612

Conversation

poppyseedDev commented Nov 21, 2024 • edited Loading

Key Improvements

Section Updates

Welcome to fhEVM

Getting Started

Fundamentals

Configuration

Guides

Tutorials

References

Developer

Future TODOs

PacificYield Nov 25, 2024

Choose a reason for hiding this comment

poppyseedDev Nov 25, 2024

Choose a reason for hiding this comment

PacificYield Nov 25, 2024

Choose a reason for hiding this comment

poppyseedDev Nov 25, 2024

Choose a reason for hiding this comment

immortal-tofu commented Nov 25, 2024

PacificYield Nov 27, 2024

Choose a reason for hiding this comment

poppyseedDev Nov 28, 2024 • edited Loading

Choose a reason for hiding this comment

immortal-tofu commented Nov 28, 2024

poppyseedDev commented Nov 28, 2024

poppyseedDev commented Nov 21, 2024 •

edited

Loading

poppyseedDev Nov 28, 2024 •

edited

Loading