Merge pull request #527 from ProvableHQ/10-25-fixes

d0cd · web-flow · commit 72401bbdc226 · 2025-10-16T07:54:09.000-07:00
Fixing minor formatting issues in prep for push to website
diff --git a/documentation/cli/00_overview.md b/documentation/cli/00_overview.md
@@ -40,7 +40,7 @@ You can print the list of commands by running `leo --help`
 * [`update`](./14_update.md) - Update to the latest version of Leo.
 * [`upgrade`](./15_upgrade.md) - Upgrade a deployed program on the Aleo network.
 
-### Universal Flags:
+## Universal Flags
 These flags are available to use alongside all commands in the Leo CLI.
 
 #### `-h`
diff --git a/documentation/cli/01_account.md b/documentation/cli/01_account.md
@@ -1,18 +1,22 @@
 ---
 id: cli_account
-title: leo account
+title: ""
 sidebar_label: Account
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_account, account, sign, verify, signature, private_key, view_key, address)
 
+# `leo account`
+
 The `leo account` command is used to create and manage Aleo accounts, as well as sign and verify messages
 
 :::warning
 We urge you to exercise caution when managing your private keys. `leo account` cannot be used to recover lost keys.
 :::
 
 
-## Subcommands
+# Subcommands
 * [`new`](#leo-account-new) - Generates a new Aleo account.
 * [`import`](#leo-account-import) - Derive and Aleo account from a private key.
 * [`sign`](#leo-account-sign) - Sign a message using your Aleo private key.
diff --git a/documentation/cli/02_add.md b/documentation/cli/02_add.md
@@ -1,10 +1,14 @@
 ---
 id: cli_add
-title: leo add
+title: ""
 sidebar_label: Add 
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_add, add_dependency, dependency, dependency_management, imports)
 
+# `leo add`
+
 The `leo add` command is used to add a new on-chain or local dependency to the current Leo project.
 
 
diff --git a/documentation/cli/03_build.md b/documentation/cli/03_build.md
@@ -1,13 +1,13 @@
 ---
 id: cli_build
-title: leo build
+title: ""
 sidebar_label: Build
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_build, build, compile, program)
 
-## `leo build`
-
-[Back to Top](#commands)
+# `leo build`
 
 To compile your program into Aleo instructions and verify that it builds properly, run:
 ```bash
diff --git a/documentation/cli/04_clean.md b/documentation/cli/04_clean.md
@@ -1,10 +1,12 @@
 ---
 id: cli_clean
-title: leo clean
+title: ""
 sidebar_label: Clean
 ---
 [general tags]: # (cli, leo_clean, clean)
 
+# `leo clean`
+
 To clean the build directory, run:
 ```bash
 leo clean
diff --git a/documentation/cli/05_debug.md b/documentation/cli/05_debug.md
@@ -1,10 +1,12 @@
 ---
 id: cli_debug
-title: leo debug
+title: ""
 sidebar_label: Debug
 ---
 [general tags]: # (cli, leo_debug, debug, debugger)
 
+# `leo debug`
+
 To start the interactive debugger, run `leo debug` in a Leo project.
 
 ```bash
diff --git a/documentation/cli/06_deploy.md b/documentation/cli/06_deploy.md
@@ -1,10 +1,14 @@
 ---
 id: cli_deploy
-title: leo deploy
-sidebar_label: deploy
+title: ""
+sidebar_label: Deploy
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_deploy, deploy, deployment, transaction, program)
 
+# `leo deploy`
+
 :::note
 This command requires having a funded account. 
 :::
diff --git a/documentation/cli/07_devnet.md b/documentation/cli/07_devnet.md
@@ -1,20 +1,13 @@
 ---
 id: cli_devnet
-title: leo devnet
+title: ""
 sidebar_label: Devnet
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_devnet, devnet local_devnet, snarkos)
 
-## `leo devnet`
-[Back to Top](#commands)
-:::tip
-Use this command to initialize a local devnet
-:::
-<!-- markdown-link-check-disable -->
-:::info
-The default ENDPOINT for a local devnet is `http://localhost:3030`
-:::
-<!-- markdown-link-check-enable -->
+# `leo devnet`
 
 To intialize a local devnet, run the following command:
 ```bash
@@ -24,6 +17,12 @@ where `<SNARKOS>` should be the path to an installed binary of snarkOS.
 
 If you don't have snarkOS installed, you can do so by passing the `--install` flag, which will install the binary at the path specified above.
 
+<!-- markdown-link-check-disable -->
+:::info
+The default ENDPOINT for a local devnet is `http://localhost:3030`
+:::
+<!-- markdown-link-check-enable -->
+
 ### Flags:
 #### `--snarkos <SNARKOS>`
 Specifies the path to the installed snarkOS binary.
diff --git a/documentation/cli/08_execute.md b/documentation/cli/08_execute.md
@@ -1,13 +1,13 @@
 ---
 id: cli_execute
-title: leo execute
+title: ""
 sidebar_label: Execute
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_execute, execute, execution, transaction, transition, transaction_status, async_transition)
 
-:::note
-This command requires having a funded account. 
-:::
+# `leo execute`
 
 You can execute a transition function by using the `leo execute` command.  This differs from the `leo run` command in that a transaction and proof of execution are produced, and optionally can be broadcasted to the network.
 
@@ -17,6 +17,10 @@ leo execute <TRANSITION_NAME> <INPUTS>
 ```
 where `<TRANSITION_NAME>` is the name of the `transition` or `async transition` function to execute and `<INPUTS>`is a list of inputs to the program separated by spaces.
 
+:::note
+This command requires having a funded account. 
+:::
+
 Under the hood, this command synthesizes the program circuit and generates proving and verifying keys.
 
 
diff --git a/documentation/cli/09_new.md b/documentation/cli/09_new.md
@@ -1,10 +1,12 @@
 ---
 id: cli_new
-title: leo new
+title: ""
 sidebar_label: New
 ---
 [general tags]: # (cli, leo_new, new, new_project)
 
+# `leo new`
+
 To create a new project, run:
 ```bash
 leo new <NAME>
diff --git a/documentation/cli/10_query.md b/documentation/cli/10_query.md
@@ -1,14 +1,18 @@
 ---
 id: cli_query
-title: leo query
+title: ""
 sidebar_label: Query
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_query, query, block, transaction, program, stateroot, committee, mempool, peers, snarkOS, mapping)
 
+# `leo query`
+
 The `leo query` command is used to get data from a network supporting the canonical `snarkOS` endpoints.
 
 
-## Subcommands
+# Subcommands
 * [`block`](#leo-query-block) - Query block information.
 * [`transaction`](#leo-query-transaction) - Query transaction information.
 * [`program`](#leo-query-program) - Query program source code and live mapping values.
@@ -22,7 +26,7 @@ The `leo query` command is used to get data from a network supporting the canoni
 ---
 
 
-### `leo query block`
+## `leo query block`
 
 To fetch blocks from a given network, run the following command
 ```bash
@@ -99,7 +103,7 @@ leo query block <BLOCK_HASH> --to-height
 
 ---
 
-### `leo query transaction`
+## `leo query transaction`
 
 To fetch a specific transaction from a given network, run the following command:
 
@@ -151,7 +155,7 @@ leo query transaction --from-program <PROGRAM_NAME>
 
 ---
 
-### `leo query program`
+## `leo query program`
 
 To fetch a specific program from a given network, run the following command:
 
@@ -191,7 +195,7 @@ The edition of the program is set to `0` upon initial deployment and is incremen
 
 ---
 
-### `leo query stateroot`
+## `leo query stateroot`
 
 This command queries the latest stateroot of a given network. 
 
@@ -206,7 +210,7 @@ The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set man
 
 ---
 
-### `leo query committee`
+## `leo query committee`
 
 This command queries the current validator committee for a given network. 
 
@@ -221,7 +225,7 @@ The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set man
 
 ---
 
-### `leo query mempool`
+## `leo query mempool`
 
 This command queries transactions and transmissions from the memory pool for a node on a given network.
 
@@ -260,7 +264,7 @@ The endpoint to deploy to. Overrides any `ENDPOINT` environment variable set man
 
 ---
 
-### `leo query peers`
+## `leo query peers`
 
 This command queries peer information for a node on a given network.
 
diff --git a/documentation/cli/11_remove.md b/documentation/cli/11_remove.md
@@ -1,10 +1,14 @@
 ---
 id: cli_remove
-title: leo remove
+title: ""
 sidebar_label: Remove
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_remove, remove_dependency, dependency, dependency_management, imports)
 
+# `leo remove`
+
 To remove a dependency from your project, run the following command:
 
 ```bash
diff --git a/documentation/cli/12_run.md b/documentation/cli/12_run.md
@@ -1,15 +1,15 @@
 ---
 id: cli_run
-title: leo run
+title: ""
 sidebar_label: Run
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_run, run, transition, async_transition)
 
-:::tip
-Use this command to run your program before [**executing**](#leo-execute) it.
-:::
+# `leo run`
 
-You can run a transition function by using the `leo run` command.  This will simply run the specified transition function with the provided inputs and show what the produced output will be.  It will NOT generate the zero-knowledge proof of execution or the transaction, and nothing will be run onchain.  For that, please see the `leo execute` command.
+You can run a transition function by using the `leo run` command.  This will simply run the specified transition function with the provided inputs and show what the produced output will be.  It will NOT generate the zero-knowledge proof of execution or the transaction, and nothing will be run onchain.  For that, please see the [`leo execute`](08_execute.md) command.
 
 To run a Leo transition function with inputs from the command line, run the following command:
 ```bash
diff --git a/documentation/cli/13_test.md b/documentation/cli/13_test.md
@@ -1,10 +1,14 @@
 ---
 id: cli_test
-title: leo test
+title: ""
 sidebar_label: Test
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_test, testing)
 
+# `leo test`
+
 This command runs all the test cases specified in the Leo file in `tests/`.  
 
 If you want to run a specific set of tests, run the following command:
diff --git a/documentation/cli/14_update.md b/documentation/cli/14_update.md
@@ -1,10 +1,14 @@
 ---
 id: cli_update
-title: leo update
+title: ""
 sidebar_label: Update
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_update, versioning)
 
+# `leo update`
+
 To download and install the latest Leo version run:
 
 ```bash
diff --git a/documentation/cli/15_upgrade.md b/documentation/cli/15_upgrade.md
@@ -1,10 +1,14 @@
 ---
 id: cli_upgrade
-title: leo upgrade
+title: ""
 sidebar_label: Upgrade
+toc_min_heading_level: 2
+toc_max_heading_level: 2
 ---
 [general tags]: # (cli, leo_upgrade, upgrade, program)
 
+# `leo upgrade`
+
 Upgrades a program that is already deployed on the network.
 
 See the **[Upgrading Programs](./../guides/10_program_upgradability.md)** guide for more details.
diff --git a/documentation/getting_started/01_installation.md b/documentation/getting_started/01_installation.md
diff --git a/documentation/guides/02_dependencies.md b/documentation/guides/02_dependencies.md
diff --git a/documentation/guides/05_signing.md b/documentation/guides/05_signing.md
diff --git a/documentation/guides/10_program_upgradability.md b/documentation/guides/10_program_upgradability.md
diff --git a/documentation/language/03_data_types.md b/documentation/language/03_data_types.md
