bedrock
bedrock copied to clipboard
Fix #13288: Convert docs to mkdocs
Preview the new docs here https://pmac.github.io/bedrock/
Excited for this change 🎉
There's an issue for this here if you wanna reference / close it when this merges: https://github.com/mozilla/bedrock/issues/13288
Nice work!
Thanks y'all. Hoping to get a demo up somewhere today so folks can test drive it.
One big question is where to host the new docs. It's easy to host them at GH Pages with a documented GH Action, but that would put them at mozilla.github.io/bedrock/. If we do that what do we do with bedrock.rtfd.org? Just delete it? Update those docs to just say that we've moved and link to the new one? Or do we try to get ReadTheDocs to build and host the new docs?
https://pmac.github.io/bedrock/
One big question is where to host the new docs. It's easy to host them at GH Pages with a documented GH Action, but that would put them at mozilla.github.io/bedrock/. If we do that what do we do with bedrock.rtfd.org? Just delete it? Update those docs to just say that we've moved and link to the new one? Or do we try to get ReadTheDocs to build and host the new docs?
I'd be cool with hosting them on GitHub via an action, and then updating the old docs to link to the new place 👍
@pmac I've mentioned in https://github.com/mozilla/bedrock/issues/13288#issuecomment-2021354702 that if you're ok with hosting on rtfd.org and don't mind the occasional ethical-ads in the sidebar you can build&deploy MkDocs to readthedocs via GH Action as well: https://github.com/readthedocs-examples/example-mkdocs-basic#readme