Documentation Updates: reorder README and combine with STATUS.md #602
Conversation
This file contains 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
jordancarlin
force-pushed
the
readme_updates
branch
2 times, most recently
from
5e1054b
to
a24f1d0
Compare
Timmmm
reviewed
Oct 23, 2024
jordancarlin
force-pushed
the
readme_updates
branch
2 times, most recently
from
d7b2c78
to
025565c
Compare
jordancarlin
force-pushed
the
readme_updates
branch
from
025565c
to
efc5201
Compare
Timmmm
approved these changes
Oct 28, 2024
|
LGTM; I'll merge this if nobody objects. |
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.
Closes #576, the current
STATUS.mdfiles has fallen very far out of date. This removes it in favor of a list of supported extensions/features in the main README. I also reordered the README to put the "Getting Started" section near the top and did some other general cleanup with it.Also wondering if it is worth keeping the entire section on what Sail is. We already link to the Sail repo, so it might make more sense to remove this and just include a quick sentence or two overview.
Going through the list of supported extensions also discovered a few missing extensions that we basically already have support for. See #603 and #604.