Add mdBook stub #527
Add mdBook stub #527
Conversation
| with: | ||
| crate: mdbook | ||
| version: "0.4" | ||
| - run: mdbook test |
There was a problem hiding this comment.
This looks good, might be good to add a single test to verify its working as expected.
We could look into auto publishing (on main or on-release workflows): https://github.com/peaceiris/actions-mdbook Because we already have a GH token to publish to the benchmarks repo which has a public HTML page: https://risc0.github.io/benchmarks/
There was a problem hiding this comment.
Agreed and then we could probably just rename benchmarks to something more generic, "assets", "internal-website", ???.
There was a problem hiding this comment.
Agreed, it got overloaded when I started pushing crate-validator results there. I had it on my TODO to rename that repo but required changing a few other things. I can probably do that sooner though if we land on a name. generated-content might work?
There was a problem hiding this comment.
The only reason I was leaving out auto-publishing was to "not include a deployment, on the principle that we shouldn't deploy something that doesn't have content" -- but it's not like this has content we don't want anyone to see. So I'll look into doing auto publishing, thanks for the references!
.github/workflows/mdbook.yml
Outdated
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Setup mdBook | ||
| uses: peaceiris/actions-mdbook@v1 |
There was a problem hiding this comment.
TBD: review the code and fork it to risc0 org.
|
Based on in-person discussion my plan is to roll back the deployment portion of this PR and split it off into its own PR. Then this can land before we've fully sorted out the deployment story. |
This reverts commit 6b8314e.
This PR starts a new mdBook in
docs/mdbook, and adds it to CI.Currently this is a stub. Also, CI includes running tests (although there is nothing to test yet), but does not include a deployment, on the principle that we shouldn't deploy something that doesn't have content, and that even as we add content it will be ugly for a while. I did write a short list of links to other content for the stub, so if we think it's important to be deploying this from day 1 we could set that up and not confuse our users too badly. It does deploy successfully locally with
mdbook serve --open.CI appears to be working fine, giving the same output as on my local machine, but I'm interested in any feedback about whether organizing this into the
doccheck was the right approach.