Closed Dominik1999 closed 2 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.
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.
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.
The script can be manually triggered or run once a week. We don't update our instructions that often.
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.
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
Instructions
are shown on a separate page (like Opcodes here)