0xPolygonMiden / compiler

Compiler from MidenIR to Miden Assembly
MIT License
63 stars 21 forks source link

docs: revisit/update documentation #305

Closed bitwalker closed 4 weeks ago

bitwalker commented 4 weeks ago

This PR contains all the updates I made while reviewing the docs, and expanding in various places. I discovered a few small bugs in the process as well.

One thing that was obvious pretty quickly, is that the miden CLI needs a lot of love, miden run is totally broken at the moment for anything involving MAST. I was unable to test that part of one of the guides due to this. The good news is, those things should be relatively easy to fix, but something we'll need to be aware of.

I think we also need to expand our docs on getting started with the Cargo extension, we have the basics, but it would be nice to have a more robust walkthrough/tutorial type thing. Might need to wait until we have support for accounts/note scripts though, we'll see.

Once this is merged, we should release 0.0.6 (to pick up the fixes contained here), and merge next into main so that the docs can be published to production.