Improve features documentation #445
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
vinistock
reviewed
Sep 3, 2024
st0012
force-pushed
the
improve-documentation
branch
from
d4182af to
314da6f
Compare
st0012
commented
Sep 3, 2024
| @@ -0,0 +1,98 @@ | |||
| # Features | |||
|
|
|||
There was a problem hiding this comment.
I decided not to add table of contents because RDoc generates header anchors in a weird format, like label-Document+Symbol for Document Symbol, instead of just document-symbol.
Since snapper already has a table of contents on the side, it should be fine.
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 https://github.com/Shopify/team-ruby-dx/issues/1241
The idea is to keep things simple and prioritize content creation. Therefore, we decided to display features similar to rust-analyzer does.
FEATURES.mdto display supported features with demonstration gifsQuick Preview
Screen.Recording.2024-08-30.at.22.02.45.mov