Integrate rgbds-live - Githubissues

avivace commented 3 years ago

@daid 's RGBDS-live is a super cool tool that I'd love to see it integrated in Pan Docs for the ASM snippets we have here.

It's quite a big deal to implement such integration, but I actually see two big things a template-able minimal rgbds-ui should support:

Hide code: snippets require some init code before/after, this code must be hidden if not explicitly requested but still executed/accessible
Expose registries and peripherals. Each snippet explains something that can be understood by looking at what changed in the other registries or in the peripherlas (e.g. display). This must be configurable snippet-wise

In the end, code snippets will look very similar to what they are now, with just a couple of UI additions enabling users to run and play with the snippets, immediatly seeing the (scoped) effect on hardware.

ISSOtm commented 3 years ago

This sounds similar to mdBook's existing "playground" feature, which is currently Rust-only. There is anupstream issue about this: rust-lang/mdbook#1276

avivace commented 3 years ago

This sounds similar to mdBook's existing "playground" feature, which is currently Rust-only. There is anupstream issue about this: rust-lang/mdBook#1276

I don't think that's what we want here, as it relies on using a restful API (do we want to mantain a "rgbds as a service"?) when we have rgbds already running in the browser..

gbdev / pandocs

Integrate rgbds-live #357