Merge pull request #302 from 0xPolygonMiden/greenhat/fix-mkdocs-warnings

chore: fix mkdocs warnings, move cargo-miden README to docs
0xPolygonMiden · Sep 5, 2024 · 57e7b2e · 57e7b2e
2 parents 5c5fae4 + 33de08a
commit 57e7b2e
Show file tree

Hide file tree

Showing 5 changed files with 50 additions and 44 deletions.
diff --git a/docs/README.md → docs/README.txt b/docs/README.md → docs/README.txt
diff --git a/docs/canonabi-adhocabi-mismatch.md → docs/appendix/canonabi-adhocabi-mismatch.md b/docs/canonabi-adhocabi-mismatch.md → docs/appendix/canonabi-adhocabi-mismatch.md
diff --git a/docs/usage/cargo-miden.md b/docs/usage/cargo-miden.md
@@ -0,0 +1,48 @@
+# Miden Cargo Extension
+
+`cargo-miden` crate provides a cargo extension that allows you to compile Rust code to Miden VM MASM.
+
+## Installation
+
+In order to install(build) the extension, you need to have the nightly Rust toolchain installed:
+
+```bash
+rustup toolchain install nightly-2024-05-07
+```
+
+To install the extension, run:
+
+```bash
+cargo +nightly-2024-05-07 install cargo-miden
+```
+
+## Usage
+
+### Getting help
+To get help with the extension, run:
+
+```bash
+cargo miden
+```
+
+Or for help with a specific command:
+
+```bash
+cargo miden <command> --help
+```
+
+### Creating a new project
+To create a new Miden VM project, run:
+
+```bash
+cargo miden new <project-name>
+```
+
+### Compiling a project
+To compile a Rust crate to Miden VM MASM, run:
+
+```bash
+cargo miden build 
+```
+
+Without any additional arguments, this will compile the library target in the target directory in the `miden` folder.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,6 +38,7 @@ nav:
       #- Testing:
   - Appendices:
       - Calling Conventions: appendix/calling_conventions.md
+      - Canonical ABI vs Miden ABI: appendix/canonabi-adhocabi-mismatch.md  
 
 markdown_extensions:
   - toc:

diff --git a/tools/cargo-miden/README.md b/tools/cargo-miden/README.md
@@ -2,47 +2,4 @@
 
 This crate provides a cargo extension that allows you to compile Rust code to Miden VM MASM.
 
-## Installation
-
-In order to install(build) the extension, you need to have the nightly Rust toolchain installed:
-
-```bash
-rustup toolchain install nightly-2024-05-07
-```
-
-To install the extension, run:
-
-```bash
-cargo +nightly-2024-05-07 install cargo-miden
-```
-
-## Usage
-
-### Getting help
-To get help with the extension, run:
-
-```bash
-cargo miden
-```
-
-Or for help with a specific command:
-
-```bash
-cargo miden <command> --help
-```
-
-### Creating a new project
-To create a new Miden VM project, run:
-
-```bash
-cargo miden new <project-name>
-```
-
-### Compiling a project
-To compile a Rust crate to Miden VM MASM, run:
-
-```bash
-cargo miden build 
-```
-
-Without any additional arguments, this will compile the library target in the target directory in the `miden` folder.
+See the [documentation](/docs/usage/cargo-miden.md) for more details.