search

roadster-rs / roadster

"Batteries Included" web framework for Rust designed to get you moving fast 🏎️
Apache License 2.0
3 stars 0 forks source link

Documentation using mdbook #18

Open spencewenski opened 3 months ago

spencewenski commented 3 months ago

https://github.com/rust-lang/mdBook/tree/master

https://rust-lang.github.io/mdBook/

spencewenski commented 3 months ago

How to build on vercel, if we want: https://github.com/orgs/vercel/discussions/3322

Todo: do we need a GitHub action to deploy to vercel?

todo: we can/should probably wait to deploy the book until we’re ready to make the repo public, at which time we can deploy using GitHub pages. However, vercel may be easier to use than GH pages? TBD

spencewenski commented 3 months ago

“mdbook test” with 3rd party packages: https://crates.io/crates/mdbook-keeper

spencewenski commented 2 months ago

The downside of this is then we need to maintain two sets of documentation — code comments/readmes and the book. We should probably hold off on trying to document via a book until we start feeling limited by the capabilities and/or accessibility (in terms of ease of adoption) of the non-book docs.