Skip to content

Commit 49a3230

Browse files
committed
chore: Update docs
1 parent 9ccde5d commit 49a3230

2 files changed

Lines changed: 26 additions & 16 deletions

File tree

README.md

Lines changed: 25 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,6 @@ Connect Nova to **[Solargraph](https://solargraph.org)** language server. Solarg
99
1010
## Features
1111

12-
### Supported
13-
1412
- Code completions
1513
- Go to definition
1614
- Diagnostics (RuboCop required)
@@ -21,40 +19,52 @@ Connect Nova to **[Solargraph](https://solargraph.org)** language server. Solarg
2119
- Workspace symbols
2220
- Rename symbol
2321

24-
### Not supported
22+
## Setup
2523

26-
- Code folding
27-
- Search documentation
28-
- On type formatting
24+
Start by installing the Ruby gem:
2925

30-
## Requirements
26+
```
27+
$ gem install solargraph
28+
```
3129

32-
You need to install the Ruby gem:
30+
Then install the documentation for the current version of Ruby:
3331

3432
```
35-
$ gem install solargraph
33+
$ solargraph download-core
34+
```
35+
36+
Finally generate the documentation for the installed gems:
37+
38+
```
39+
$ yard gems
3640
```
3741

38-
### Run from bundle
42+
### Ruby on Rails setup
43+
44+
Follow this [guide](https://solargraph.org/guides/rails) to configure Solargraph so it can pair well with Rails.
45+
46+
Consider installing this [plugin](https://github.com/iftheshoefritz/solargraph-rails) too.
47+
48+
## Launch from bundle
3949

40-
If you want you can use the Solargraph version installed in your project bundle.
50+
Alternatively, the extension can also launch Solargraph from the project bundle.
4151

4252
Start by adding the gem to the development group:
4353

4454
```
4555
$ bundle add solargraph --group=development --require=false
4656
```
4757

48-
Then you can check the `Use Bundler` config in the extension or project settings.
58+
Then check the `Use Bundler` config in the extension or project settings.
4959

50-
> Warning: If you have the `Use Bundler` config checked but you have not added Solargraph to the bundle, the extension will raise an error.
60+
> Warning: If the `Use Bundler` config is checked but Solargraph is not in the bundle, the extension will raise an error.
5161
5262
## Diagnostics & Formatting
5363

5464
Solargraph uses [RuboCop](https://rubocop.org) to provide diagnostics and formatting. Make sure to install that gem too.
5565

56-
When you have RuboCop installed you can opt-in for diagnostics and formatting from the extension or project settings.
66+
When RuboCop is installed you can opt-in for diagnostics and formatting from the extension or project settings.
5767

5868
## Find references & Workspace symbols
5969

60-
You can see the workspace symbols and find references results in the Nova's Solargraph sidebar.
70+
Workspace symbols and find references results are going to be displayed in the Solargraph sidebar inside Nova.

extension.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"identifier": "com.tommasonegri.solargraph",
33
"name": "Solargraph",
44
"organization": "Tommaso Negri",
5-
"description": "A Ruby language server featuring code completion, intellisense, and inline documentation.",
5+
"description": "A Ruby language server featuring code completion, intellisense, and inline documentation",
66
"version": "1.0",
77

88
"license": "MIT",

0 commit comments

Comments
 (0)