hydro-project / hydroflow

Hydro's low-level dataflow runtime
https://hydro.run/docs/hydroflow/
Apache License 2.0
473 stars 33 forks source link

Run mdbook tests on Hydroflow+ docs #1012

Open shadaj opened 9 months ago

shadaj commented 9 months ago

Not sure how feasible this actually is given that Stageleft is involved, but we need some solution to ensure that the docs aren't out of date. Maybe we should pull the snippets directly from Rust files or something.

MingweiSamuel commented 9 months ago

Maybe we should pull the snippets directly from Rust files or something.

Yeah I set up some stuff for this for the hydroflow quickstart examples

https://github.com/hydro-project/hydroflow/blob/4bdd5568fa0a6674f650f91a029fab302cbf14f4/docs/docs/hydroflow/quickstart/example_5_reachability.mdx#L55-L67

MingweiSamuel commented 1 month ago

(half completed in #1318)