Conversation
thomasleese
approved these changes
Mar 19, 2026
jf-x-dev
force-pushed
the
add-reference-doc
branch
from
c20b506 to
cf04c8a
Compare
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
2 participants
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 adds a quick reference document that informs the user how the important end-to-end workflows work, and links to it in the main
README.md.I've avoided including too much detail so that in theory this should not need to be maintained too much. It should serve as a quick "how to" rather than extensive documentation.
I can raise a PR to link to this in the main Mavis repo README after review