Merge pull request #418 from phklive/phklive-add-mdbook

Update structure of SUMMARY.md
0xPolygonMiden · Mar 4, 2025 · ecba975 · ecba975
2 parents f510174 + 06d63c9
commit ecba975
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 31 deletions.
diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md
@@ -1,31 +1,19 @@
-# Reference
-
-[Getting Started](getting_started.md)
-
----
-
-# Usage
-
-- [As an Executable](usage/midenc.md)
-- [As a Cargo extension](usage/cargo-miden.md)
-
-# Guides
-
-- [Rust To WebAssembly](guides/rust_to_wasm.md)
-- [WebAssembly To Miden Assembly](guides/wasm_to_masm.md)
-- [Developing Miden Programs In Rust](guides/develop_miden_in_rust.md)
-- [Developing Miden Rollup Accounts And Note Scripts In Rust](guides/develop_miden_rollup_accounts_and_note_scripts_in_rust.md)
-- [Debugging programs](usage/debugger.md)
-
-# Compiler architecture
-
-- [Overview](design/overview.md)
-- [Frontends](design/frontends.md)
-
----
-# Appendices:
-
-- [Known limitations](appendix/known-limitations.md)
-- [Calling Conventions](appendix/calling_conventions.md)
-- [Canonical ABI vs Miden ABI](appendix/canonabi-adhocabi-mismatch.md)
-
+# Summary
+
+- [Compiler](./getting_started.md)
+    * [Usage](./usage/index.md)
+        + [As an Executable](./usage/midenc.md)
+        + [As a Cargo extension](./usage/cargo-miden.md)
+    * [Guides](./guides/index.md)
+        + [Rust To WebAssembly](./guides/rust_to_wasm.md)
+        + [WebAssembly To Miden Assembly](./guides/wasm_to_masm.md)
+        + [Developing Miden Programs In Rust](./guides/develop_miden_in_rust.md)
+        + [Developing Miden Rollup Accounts And Note Scripts In Rust](./guides/develop_miden_rollup_accounts_and_note_scripts_in_rust.md)
+        + [Debugging programs](./usage/debugger.md)
+    * [Architecture](./design/index.md)
+        + [Overview](./design/overview.md)
+        + [Frontends](./design/frontends.md)
+    * [Appendices](./appendix/index.md)
+        + [Known limitations](./appendix/known-limitations.md)
+        + [Calling Conventions](./appendix/calling_conventions.md)
+        + [Canonical ABI vs Miden ABI](./appendix/canonabi-adhocabi-mismatch.md)
diff --git a/docs/src/appendix/index.md b/docs/src/appendix/index.md
@@ -0,0 +1 @@
+# Appendices
diff --git a/docs/src/design/index.md b/docs/src/design/index.md
@@ -0,0 +1 @@
+# Architecture
diff --git a/docs/src/guides/index.md b/docs/src/guides/index.md
@@ -0,0 +1 @@
+# Guides
diff --git a/docs/src/usage/index.md b/docs/src/usage/index.md
@@ -0,0 +1 @@
+# Usage