Upgrade our service documentation to the MyST engine - #311
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR upgrades our /docs site to use the new MyST engine! I believe that this should "just work" - let's see how the PR preview does.
🖼️ Here's the ReadTheDocs preview (for some reason it's not being auto-added to this PR? Maybe because of that action we have that calls it? EDIT: Fixed it by re-connecting the github app)
Plan for this PR
What I did
Here are a few things that I did:
{role}) and just used myst labels for those{guilabel}uses.There were some other cleanups here and there but that's the main stuff I can remember. This is another PR that touches a bunch of files, so maybe Angus could take a quick look and push whatever he changes he likes, and then merge when he thinks it's OK?