Following up on our decision about #38, we will move the source of truth for jet documentation back to the SimplicityHL repo (and in any case not manually maintain jets.json in this repo). Once the SimplicityHL repo is automatically exporting a JSON file with jet documentation, we need to automatically import that into this repo and automatically generate markdown from it.
The generation of markdown from jets.json is already handled by https://github.com/BlockstreamResearch/simplicity-lang-org/blob/main/jets.md.py, so we mainly just need to run that automatically.
We should also consider how we will handle the versions of the jets list for the different Simplicity integrations. I believe @gerau is planning to call them elements.json, unchained.json, etc., which is not difficult to handle in this repo, but we'll eventually also need some kind of user interface to let a user easily recognize which documentation relates to which Simplicity integration, and to switch between them.
Following up on our decision about #38, we will move the source of truth for jet documentation back to the SimplicityHL repo (and in any case not manually maintain
jets.jsonin this repo). Once the SimplicityHL repo is automatically exporting a JSON file with jet documentation, we need to automatically import that into this repo and automatically generate markdown from it.The generation of markdown from
jets.jsonis already handled by https://github.com/BlockstreamResearch/simplicity-lang-org/blob/main/jets.md.py, so we mainly just need to run that automatically.We should also consider how we will handle the versions of the jets list for the different Simplicity integrations. I believe @gerau is planning to call them
elements.json,unchained.json, etc., which is not difficult to handle in this repo, but we'll eventually also need some kind of user interface to let a user easily recognize which documentation relates to which Simplicity integration, and to switch between them.