-
Notifications
You must be signed in to change notification settings - Fork 918
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix #13288: Convert docs to mkdocs #13872
base: main
Are you sure you want to change the base?
Conversation
61c927d
to
31c47d1
Compare
Excited for this change 🎉 |
There's an issue for this here if you wanna reference / close it when this merges: #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? |
ec96efa
to
5f28069
Compare
6fd178d
to
d608932
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs a rebase, but moving to markdown looks like a great improvement to me, and the new docs themselves seem like they are definitely more usable. r+!
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 #13288 (comment) 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 |
Preview the new docs here https://pmac.github.io/bedrock/