Improve the project's readme #32
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
approved these changes
Apr 18, 2023
|
Left a few suggestions but not critical. |
andyw8
reviewed
Apr 18, 2023
|
|
||
| The RailsRubyLsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features. As long | ||
| as this gem is a part of the project's bundle, the Ruby LSP will automatically load it to provide extra features. | ||
| The Rails Ruby Lsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as: |
There was a problem hiding this comment.
Suggested change
| The Rails Ruby Lsp is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as: | |
| The Rails Ruby LSP is a [Ruby LSP](https://github.com/Shopify/ruby-lsp) extension for extra Rails editor features, such as: |
| ## Usage | ||
|
|
||
| 1. Start your Rails server | ||
| 1. Hover over an ActiveRecord model to see its details |
There was a problem hiding this comment.
Suggested change
| 1. Hover over an ActiveRecord model to see its details | |
| 1. Hover over an ActiveRecord model class name to see its details |
(in case people mistakenly try to hover over the filename, etc.)
|
|
||
| This gem consists of two components that enable enhanced Rails functionality in the editor: | ||
|
|
||
| 1. A Rails engine that automatically exposes APIs when Rails server is running |
There was a problem hiding this comment.
Suggested change
| 1. A Rails engine that automatically exposes APIs when Rails server is running | |
| 1. A Rails engine that exposes APIs while the Rails server is running. |
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.
No description provided.