Initial stab at mode documentation #3955
Open
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 adds some high-level documentation for our modes. The idea is to have a page that gives a brief overview of the whole suite of modes, without getting too far into the details of any one of them (for which it refers to the documentation about that particular feature).
I haven't attempted to write docs about the following axes: statefulness, visibility, yielding. Either someone else can write those and push them here, or they can be added in a future PR.