chore: categorizing sidebar topics

AleoNet · Oct 7, 2024 · 42c1ffc · 42c1ffc
1 parent 56a4d74
commit 42c1ffc
Show file tree

Hide file tree

Showing 8 changed files with 39 additions and 11 deletions.
diff --git a/documentation/advanced/dive-into-avm/00_overview.md b/documentation/advanced/dive-into-avm/00_overview.md
@@ -1,7 +1,7 @@
 ---
 id: overview
-title: Overview
-sidebar_label: Overview
+title: Aleo Virtual Machine (AVM)
+sidebar_label: Aleo Virtual Machine (AVM)
 ---
 
 The Aleo Virtual Machine (AVM) is a computational platform integral to the Aleo blockchain, designed to run privacy-focused applications. It operates as a stack machine that executes queued instructions. Its primary function is to construct arithmetic circuits described as Rank-1 Constraint System (R1CS), from each instruction in a function.

diff --git a/documentation/advanced/intro-to-zksnark/00_overview.md b/documentation/advanced/intro-to-zksnark/00_overview.md
@@ -1,7 +1,7 @@
 ---
-id: overview
-title: Overview
-sidebar_label: Overview
+id: intro_to_zksnark
+title: Intro to zkSNARK
+sidebar_label: Intro to zkSNARK
 ---
 
 In this section we cover the general intuition of a zk proof, we outline the steps in creating a zksnark, we define the actors in a zk proof mainly the prover and verifier. We also introduce the elements in a zkproof like the witness, intermediate representation, trusted setups, structured reference strings and random oracles. We also give the context of where the zksnark proof is used in Aleo.

diff --git a/documentation/faq/faq.md b/documentation/faq/faq.md
@@ -1 +1,17 @@
+---
+id: faq
+title: FAQs
+sidebar_label: FAQs
+---
+- Do applications in Aleo function similarly to ZK rollups?  
 
+Differences between Aleo applications and ZK rollups:
+
+| Aspect | ZK Rollup | Aleo Application |
+|--------|-----------|-------------------|
+| Information visibility | All **information is public** | Can make some inputs private, using the **zero-knowledge** property of **zk**SNARK |
+| Proof generation | Rollup coordinator generates the proof and submits it in the rollup-transaction | Users generate the proof themselves and submit it as part of the transaction |
+| Batching | Batches multiple transactions | Can batch multiple transitions into the same **transaction** |
+| zkSNARK usage | Uses the **succinct** property to prove correct execution of a batch of transactions | Can use rollup-like architecture with added privacy features |
+
+Similar to batching multiple transactions in a zk-rollup, Aleo has a way to batch multiple **transitions** into the same **transaction**.
diff --git a/documentation/guides/00_testing.md → documentation/guides/00_leo_testing.md b/documentation/guides/00_testing.md → documentation/guides/00_leo_testing.md
@@ -1,7 +1,7 @@
 ---
 id: testing
 title: Testing Leo Programs
-sidebar_label: Testing Leo Programs
+sidebar_label: Testing 
 ---
 Depending on how thoroughly and quickly developers want to test the Leo programs, there are currently three different options in running tests.  
 
@@ -30,10 +30,10 @@ Here are the steps to start running a local devnet:
 ![TestnetValidator](./images/devnet_validator_zero.png)
 11. The private key will always stay the same for every node that runs with devnet.sh script so it only needs to remember once.
 12. The reason for taking note of validator node 0’s private key is because it is automatically funded with test Aleo Tokens (AT) with both public mapping balance and private records.
-13. To interact with the local devnet, just replace all API calls URL to http://localhost:3030.
+13. To interact with the local devnet, just replace all API calls URL to `http://localhost:3030`.
 Refer here for all the default available REST API endpoints from a validator node.
 
-Once you have a local devnet running in the background, you can start deploying a program to the devnet using leo deploy and execute transactions using leo execute to start testing any logic in the async functions and correctness of the state transitions of your programs.
+Once you have a local devnet running in the background, you can start deploying a program to the devnet using `leo deploy` and execute transactions using `leo execute` to start testing any logic in the async functions and correctness of the state transitions of your programs.
 
 ## Testing with Aleo Testnet
 The Aleo Testnet closely mimics the environment of the mainnet, providing a realistic testing scenario for developers. One important note to keep in mind is that since the Testnet is continuously running and the network identifies each program with its unique ID, developers cannot redeploy a program with the exact same ID once it has been deployed to the Testnet.  

diff --git a/documentation/guides/01_leo_best_practices.md b/documentation/guides/01_leo_best_practices.md
@@ -0,0 +1,6 @@
+---
+id: leo_best_practices
+title: Leo Best Practices
+sidebar_label: Best Practices
+---
+(wip)
diff --git a/documentation/guides/02_leo_limitations.md b/documentation/guides/02_leo_limitations.md
@@ -0,0 +1,6 @@
+---
+id: leo_limitations
+title: Leo Limitations
+sidebar_label: Limitations
+---
+(wip)
diff --git a/documentation/sdk/python/00_aleo_sdk.md b/documentation/sdk/python/00_aleo_sdk.md
@@ -1,7 +1,7 @@
 ---
 id: provable-sdk
-title: Provable SDK
-sidebar_label: Provable SDK
+title: Provable Python SDK
+sidebar_label: Provable Python SDK
 ---
 
 <!-- markdown-link-check-disable -->

diff --git a/documentation/sdk/typescript/00_sdk_overview.md b/documentation/sdk/typescript/00_sdk_overview.md
@@ -1,7 +1,7 @@
 ---
 id: overview
 title: Javascript/Typescript
-sidebar_label: Guide
+sidebar_label: Javascript/Typescript
 ---
 <!-- markdown-link-check-disable -->