Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update structure of SUMMARY.md #418

Merged
merged 4 commits into from
Mar 4, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 19 additions & 31 deletions docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -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)
1 change: 1 addition & 0 deletions docs/src/appendix/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Appendices
1 change: 1 addition & 0 deletions docs/src/design/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Architecture
1 change: 1 addition & 0 deletions docs/src/guides/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Guides
1 change: 1 addition & 0 deletions docs/src/usage/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Usage