0xPolygonMiden / examples

Examples of using Polygon Miden
MIT License
18 stars 18 forks source link

Add cool Miden assembly instructions to the playground #175

Closed Dominik1999 closed 2 months ago

Dominik1999 commented 7 months ago

Background

Currently, we have Miden assembly instructions for the playground. But, we need to maintain those instructions by hand, and how we show them is not optimal.

Screenshot 2024-04-08 at 15 51 24

Goal - have it like EVM codes

Our goal is to have Miden assembly instructions the same way as EVM instructions are shown here https://www.evm.codes/?fork=cancun

That means instead of having the instructions on the right side, next to the code editor, we want to go back and show them on their page. When a user clicks on an instruction, it should expand, and some additional information should be shown.

All assembly instructions are defined here in markdown tables https://github.com/0xPolygonMiden/miden-vm/tree/main/docs/src/user_docs.

Related to #163

To Dos

gubloon commented 7 months ago

I explored few approaches here: https://github.com/0xPolygonMiden/examples/issues/163 Maybe it can be simpler too; I can start with a PoC.

kaushalbhardwaj commented 5 months ago

For the script which will get all instructions from here into a JSON file which data we need to extract. Also when will the script will be executed to fetch instructions.

Dominik1999 commented 4 months ago

We must extract all the commands stored in tables in the .md-files.

You can cross-check in the user documentation here. We only need the instructions but not all the text around it.

Screenshot 2024-06-24 at 15 40 09

The script can be manually triggered or run once a week. We don't update our instructions that often.