Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use MDX to ensure the examples in the documentation are runnable #770

Open
shonfeder opened this issue Oct 30, 2022 · 1 comment
Open

Use MDX to ensure the examples in the documentation are runnable #770

shonfeder opened this issue Oct 30, 2022 · 1 comment

Comments

@shonfeder
Copy link
Contributor

While working through the exercises for #769 I noticed a few places where the commands in the examples had strayed from the actual state of the code. Without tests to check this, it can be quite laborious to keep such things in sync.

MDX would be a good fit here, tho I expect that would mean either moving https://github.com/mirage/mirage-skeleton into this repo, or including it as a git sub-module.

I see this was also discussed in #703.

@samoht
Copy link
Member

samoht commented Apr 12, 2024

I've started to add mdx support in #817. For now, it's just for lwt-tutorial.md, but it would be nice to add more tutorials!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants