Merge pull request #11 from matter-labs/mvprelease

MVPrelease

src/README.md

@@ -1,15 +1,14 @@
 <img src="images/foundry-banner.png" style="border-radius: 20px">
 
-Foundry-ZKsync is a smart contract development toolchain for ZKsync, built upon [Foundry](https://book.getfoundry.sh/).
+## Foundry-ZKsync Book
 
-Foundry-ZKsync manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Solidity scripts.
+**Foundry-ZKsync is a smart contract development toolchain for ZKsync**, built upon [Foundry](https://book.getfoundry.sh/).
 
-> 📖 **Contributing**
->
-> You can contribute to this book on [GitHub](https://github.com/matter-labs/foundry-zksync-book).
+Foundry-ZKsync manages your dependencies, compiles your project, runs tests, deploys, and lets you interact with the chain from the command-line and via Solidity scripts.
 
-### Sections
+> ⚠️ **Alpha Stage:** The project is in alpha, so you might encounter issues. For more information or reporting bugs, please visit the [Foundry-ZKsync GitHub repository](https://github.com/matter-labs/foundry-zksync-foundry).
 
+## Sections
 **[Getting Started](getting-started/installation.md)**
 
 To get started with Foundry-ZKsync, install Foundry-ZKsync and set up your first project.
@@ -22,6 +21,20 @@ This section will give you an overview of how to create and work with existing p
 
 This section will give you an the necessary information to write and run tests for zkEVM.
 
+**[Supported Commands Overview](supported-commands)**
+
+This section has a comprehensive review of all the Foundry commands actually supported in the Foundry-ZKSync tool.
+
+> 📖 **Contributing**
+>
+> This book is actual work in progress as part of the global efforts to support Foundry in ZKSync. More information, sections and pages will be added as we the project progresses.
+>
+> Feedback and contributions are welcome. You can contribute to this book on [Foundry-ZKSync Book GitHub repository](https://github.com/matter-labs/foundry-zksync-book).
+>
+<br>
+
+***For general information about Foundry, see the [Foundry Book](https://book.getfoundry.sh/).***
+<!--  
 **[Forge Overview](forge)**
 
 The overview will give you all you need to know about how to use `forge` to develop, test, and deploy smart contracts.
@@ -58,7 +71,8 @@ Tutorials on building smart contracts with Foundry.
 - [Testing EIP-712 Signatures](./tutorials/testing-eip712.md)
 - [Solidity Scripting](./tutorials/solidity-scripting.md)
 - [Forking Mainnet with Cast and Anvil](./tutorials/forking-mainnet-with-cast-anvil.md)
-<!-- - [Incremental Adoption]() -->
+<!-- - [Incremental Adoption]() 
+
 
 **Contributing**
 
@@ -79,3 +93,4 @@ References, troubleshooting, and more.
 - [Miscellaneous](misc)
 
 <br>
+-->

src/SUMMARY.md

@@ -18,6 +18,7 @@
 
 # ZKsync Specifics
 
+- [Overview](./zksync-specifics/README.md)
 - [Execution Overview](./zksync-specifics/execution-overview.md)
 - [Compilation Overview](./zksync-specifics/compilation-overview.md)
 - [Limitations](./zksync-specifics/limitations/README.md)
@@ -28,7 +29,10 @@
 - [Additional Cheatcodes](./zksync-specifics/cheatcodes/README.md)
   - [zkVm](./zksync-specifics/cheatcodes/zkvm.md)
 
+# Supported Commands Overview
+- [Command List](./supported-commands/README.md)
 
+<!--
 # Forge Overview
 
 - [Overview of Forge](forge/README.md)
@@ -39,17 +43,17 @@
   - [Understanding Traces](./forge/traces.md)
   - [Fork Testing](./forge/fork-testing.md)
   - [Replaying Failures](./forge/replay-testing.md)
-  <!--  - [Coverage Reports]() !-->
-- [Advanced Testing](./forge/advanced-testing.md)
+  <!--  - [Coverage Reports]() 
+ - [Advanced Testing](./forge/advanced-testing.md)
   - [Fuzz Testing](./forge/fuzz-testing.md)
   - [Invariant Testing](./forge/invariant-testing.md)
   - [Differential Testing](./forge/differential-ffi-testing.md)
-    <!--  - [Symbolic Testing]() !-->
-    <!--  - [Table Testing]() !-->
-    <!--  - [Mutation Testing]() !-->
-    <!-- - [Linting and Formatting]() !-->
-    <!-- - [Generating Documentation]() !-->
-- [Deploying and Verifying](./forge/deploying.md)
+    <!--  - [Symbolic Testing]() 
+    <!--  - [Table Testing]() 
+    <!--  - [Mutation Testing]() 
+    <!-- - [Linting and Formatting]() 
+    <!-- - [Generating Documentation]() 
+<!-- - [Deploying and Verifying](./forge/deploying.md)
 - [Gas Tracking](./forge/gas-tracking.md)
   - [Gas Reports](./forge/gas-reports.md)
   - [Gas Snapshots](./forge/gas-snapshots.md)
@@ -87,14 +91,14 @@
 - [Deterministic deployment using CREATE2](./tutorials/create2-tutorial.md)
 - [Forking Mainnet with Cast and Anvil](./tutorials/forking-mainnet-with-cast-anvil.md)
 - [Learning Foundry Videos](./tutorials/learn-foundry.md)
-<!-- - [Incremental Adoption]() !-->
+<!-- - [Incremental Adoption]() 
 
 # Appendix
 
 - [FAQ](./faq.md)
 - [Help us improve Foundry](./contributing.md)
 - [References](./reference/README.md)
-  - [CLI Reference](./reference/cli/README.md) <!-- CLI_REFERENCE START -->
+  - [CLI Reference](./reference/cli/README.md) <!-- CLI_REFERENCE START 
     - [`forge`](./reference/cli/forge.md)
       - [`forge bind`](./reference/cli/forge/bind.md)
       - [`forge bind-json`](./reference/cli/forge/bind-json.md)
@@ -242,7 +246,7 @@
         - [`cast wallet list`](./reference/cli/cast/wallet/list.md)
         - [`cast wallet private-key`](./reference/cli/cast/wallet/private-key.md)
         - [`cast wallet decrypt-keystore`](./reference/cli/cast/wallet/decrypt-keystore.md)
-  - [`forge` Commands](./reference/forge/README.md) <!-- CLI_REFERENCE END -->
+  - [`forge` Commands](./reference/forge/README.md) <!-- CLI_REFERENCE END 
     - [General Commands](./reference/forge/general-commands.md)
       - [forge](./reference/forge/forge.md)
       - [forge help](./reference/forge/forge-help.md)