Skip to content

Commit 6f93d7b

Browse files
author
Andy Waite
authored
Update links to stay within Ruby LSP docs (#3263)
* Update troubleshooting links * Use relative links * Remove .html extension
1 parent c5aba6a commit 6f93d7b

File tree

4 files changed

+12
-12
lines changed

4 files changed

+12
-12
lines changed

jekyll/add-ons.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ parent: Ruby LSP
1111
> The Ruby LSP add-on system is currently experimental and subject to changes in the API
1212
1313
Need help writing add-ons? Consider joining the `#ruby-lsp-addons` channel in the [Ruby DX Slack
14-
workspace](https://shopify.github.io/ruby-lsp/invite).
14+
workspace](invite).
1515

1616
## Motivation and goals
1717

jekyll/index.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ for Ruby, used to improve rich features in editors. It is a part of a wider goal
1515
experience to Ruby developers using modern standards for cross-editor features, documentation and debugging.
1616

1717
Want to discuss Ruby developer experience? Consider joining the public
18-
[Ruby DX Slack workspace](https://shopify.github.io/ruby-lsp/invite).
18+
[Ruby DX Slack workspace](invite).
1919

2020
## Table of Contents
2121

@@ -69,7 +69,7 @@ If using VS Code, all you have to do is install the [Ruby LSP
6969
extension](https://marketplace.visualstudio.com/items?itemName=Shopify.ruby-lsp) to get the extra features in the
7070
editor. Do not install the `ruby-lsp` gem manually.
7171

72-
For more information on using and configuring the extension, see the [extension page](vscode-extension.html).
72+
For more information on using and configuring the extension, see the [extension page](vscode-extension).
7373

7474
### With other editors
7575

@@ -531,7 +531,7 @@ requirements
531531
## Experimental Features
532532

533533
Ruby LSP also provides experimental features that are not enabled by default. If you have feedback about these features,
534-
you can let us know in the [DX Slack](https://shopify.github.io/ruby-lsp/invite) or by [creating an issue](https://github.com/Shopify/ruby-lsp/issues/new/choose).
534+
you can let us know in the [DX Slack](invite) or by [creating an issue](https://github.com/Shopify/ruby-lsp/issues/new/choose).
535535

536536
### Ancestors Hierarchy Request
537537

@@ -571,7 +571,7 @@ default gems, except for
571571
- Gems that only appear under the `:development` group
572572
- All Ruby files under `test/**/*.rb`
573573

574-
This behavior can be overridden and tuned. Learn how to configure it [for VS Code](https://github.com/Shopify/ruby-lsp/tree/main/vscode#indexing-configuration).
574+
This behavior can be overridden and tuned. Learn how to configure it [for VS Code](vscode-extension#indexing-configuration).
575575

576576
Note that indexing-dependent behavior, such as definition, hover, completion or workspace symbol will be impacted by
577577
the configuration changes.

jekyll/troubleshooting.markdown

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ As an example, the activation script for `zsh` using `rbenv` as a version manage
3030

3131
After activating the Ruby version, we then proceed to boot the server gem (`ruby-lsp`). To avoid having users include
3232
the `ruby-lsp` in their `Gemfile`, we create a [composed
33-
bundle](https://shopify.github.io/ruby-lsp/composed-bundle.html) under the `.ruby-lsp` directory inside your project.
33+
bundle](composed-bundle) under the `.ruby-lsp` directory inside your project.
3434

3535
## Common issues
3636

@@ -172,7 +172,7 @@ One scenario where this is useful is if the user doesn't have permissions for th
172172

173173
### Developing on containers
174174

175-
See the [documentation](https://github.com/Shopify/ruby-lsp/tree/main/vscode#developing-on-containers).
175+
See the [documentation](vscode-extension#developing-on-containers).
176176

177177
## Diagnosing the problem
178178

@@ -184,7 +184,7 @@ manner. Please include the steps taken to diagnose in your bug report.
184184

185185
Check the [status center](https://github.com/Shopify/ruby-lsp/blob/main/vscode/extras/ruby_lsp_status_center.png).
186186
Does the server status say it's running? If it is running, but you are missing certain features, please check our
187-
[features documentation](https://shopify.github.io/ruby-lsp/#general-features) to ensure we already added support for it.
187+
[features documentation](index#general-features) to ensure we already added support for it.
188188

189189
If the feature is listed as fully supported, but not working for you, report [an
190190
issue](https://github.com/Shopify/ruby-lsp/issues/new/choose) so that we can
@@ -201,7 +201,7 @@ Did it select your preferred version manager? You can define which version manag
201201
### Enable logging
202202

203203
You can enable logging to the VS Code output tab,
204-
[as described in the CONTRIBUTING](https://github.com/Shopify/ruby-lsp/blob/main/CONTRIBUTING.md#tracing-lsp-requests-and-responses) docs.
204+
[as described in the Contributing](contributing#tracing-lsp-requests-and-responses) docs.
205205

206206
### Environment activation failed
207207

jekyll/vscode-extension.markdown

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ The Ruby LSP features include
3232
See complete information about features [here](https://shopify.github.io/ruby-lsp).
3333

3434
If you experience issues, please see the [troubleshooting
35-
guide](https://shopify.github.io/ruby-lsp/troubleshooting.html).
35+
guide](troubleshooting).
3636

3737
### [Experimental] GitHub Copilot chat agent
3838

@@ -58,7 +58,7 @@ As with most LLM chat functionality, suggestions may not be fully accurate, espe
5858
continue chatting with the `@ruby` agent to fine tune the suggestions given, before deciding to move forward with
5959
generation.
6060

61-
If you have feedback about this feature, you can let us know in the [DX Slack](https://shopify.github.io/ruby-lsp/invite) or by [creating an issue](https://github.com/Shopify/ruby-lsp/issues/new).
61+
If you have feedback about this feature, you can let us know in the [DX Slack](invite) or by [creating an issue](https://github.com/Shopify/ruby-lsp/issues/new).
6262

6363
## Usage
6464

@@ -128,7 +128,7 @@ default shell.
128128

129129
{: .note }
130130
> For manager-specific notes, setting up custom activation for managers not listed above and community-contributed
131-
> examples, please see [version managers](https://shopify.github.io/ruby-lsp/version-managers.html).
131+
> examples, please see [version managers](version-managers).
132132
133133
#### Configuring a formatter
134134

0 commit comments

Comments
 (0)