Matthew Powers

04/17/2023, 10:58 AM
I ported the existing Delta Rust docs to mdBook and created a POC website. Here is the code (just POC, will commit to delta-rs repo is folks like this approach). mdBook provides a lot of advantages over Sphinx documentation in my opinion: • Markdown instead of RST • mdBook makes it easy to properly structure URLs (sphinx creates URLs like
that should be
). This seems minor, but it’s actually a major SEO issue. • mdBook provides some nice formatting, navigation, and search options out of the box Interested in what folks think about this option. After we decide on the framework, we can brainstorm the optimal structure of the docs. I have some ideas that should work well from a readability & SEO perspective.
❤️ 6

Jeremy Jordan

04/17/2023, 2:04 PM
this looks great!
👍 1

Cole MacKenzie

04/17/2023, 4:07 PM
Unrelated, I was working on some Rust examples too over the weekend.
🙌 1
Would be great if we can split the docs into two sections - python bindings and rust bindings

Matthew Powers

04/17/2023, 4:19 PM
@Cole MacKenzie - yep, I agree! It’d be great to have a Rust user guide as well. Let me know if you’d ever like to get some of those Rust examples in a Jupyter notebook & in the official delta-examples repo!

Jim Hibbard

04/17/2023, 4:57 PM
Nice work Matt! And definitely would love to see those additions Cole. Let either of us know if you want some help too 🙂