Skip to content

Offline, privacy-first grammar checker. Fast, open-source, Rust-powered

docs(vscode): transfer info from readme to official docs

Matthew Espino040bb51c2a28
diff --git a/packages/vscode-plugin/README.md b/packages/vscode-plugin/README.md
index e5e061031..1e0d8fe9a 100644
--- a/packages/vscode-plugin/README.md
+++ b/packages/vscode-plugin/README.md
@@ -1,35 +1,9 @@
# Harper for VS Code
-Harper is the next-generation grammar checker for your code. It catches common stylistic errors, as well as complex grammatical or layout-related problems. It works for almost [all common programming languages](./language-server#Supported-Languages) and a number of markup formats.
+Harper is the next-generation grammar checker for your code. It catches common stylistic errors, as well as complex grammatical or layout-related problems. It works for almost [all common programming languages](https://writewithharper.com/docs/integrations/language-server#Supported-Languages) and a number of markup formats.
If you use Rust, Java, JavaScript, or any number of other programming languages, your comments may end up as part of your API's documentation. If that's the case, grammatical mistakes in your code could be down-ranking your site on search results and tarnishing your reputation for quality.
Most importantly, Harper runs on-device and uses barely any memory at all. That means you can get feedback on your work in milliseconds, dramatically increasing your iteration speed.
-## Installation
-
-Installation should be relatively straightforward.
-It just depends on which editor and marketplace you're using.
-
-If you use the official Microsoft Visual Studio Code release, go ahead and go to the marketplace and search for "Harper" and click "Install".
-You can also visit our [official page](https://marketplace.visualstudio.com/items?itemName=elijah-potter.harper&ssr=false#overview).
-
-If you use OpenVSX, for instance if you use VSCodium, you'll want to install from [here](https://open-vsx.org/extension/elijah-potter/harper).
-
-### Commands
-
-| Command | Id | Description |
-| ------------------------------- | ------------------------------- | ------------------- |
-| Harper: Restart Language Server | `harper.languageserver.restart` | Restart `harper-ls` |
-
-### Settings
-
-| Setting | Type | Default Value | Description |
-| ------------------------------ | ------------------------------------------------- | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `harper-ls.path` | `string` | `""` | Optional path to a `harper-ls` executable to use. Primarily useful if the bundled binary doesn't work in your system like in immutable Linux distributions. |
-| `harper-ls.linters.*` | `boolean` | Varies | Detect and provide suggestions in a variety of common situations. |
-| `harper-ls.diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"information"` | How severe do you want diagnostics to appear in the editor? |
-
-## Developing and Contributing
-
-See the [Development Guide](/packages/vscode-plugin/development-guide.md).
+You can learn more about [this extension](https://writewithharper.com/docs/integrations/visual-studio-code) and [Harper](https://writewithharper.com/docs/about) over at our [official website](https://writewithharper.com).
diff --git a/packages/web/src/routes/docs/integrations/visual-studio-code/+page.md b/packages/web/src/routes/docs/integrations/visual-studio-code/+page.md
index 997190696..ab6822298 100644
--- a/packages/web/src/routes/docs/integrations/visual-studio-code/+page.md
+++ b/packages/web/src/routes/docs/integrations/visual-studio-code/+page.md
@@ -2,10 +2,24 @@
title: Visual Studio Code
---
-Harper is the next-generation grammar checker for your code. It catches common stylistic errors, as well as complex grammatical or layout-related problems. It works for almost [all common programming languages](./language-server#Supported-Languages) and a number of markup formats.
+For our Visual Studio Code integration, we provide an extension powered by [`harper-ls`](./language-server), which also works for VS Code forks like VSCodium and Windsurf. It's available in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=elijah-potter.harper) as well as the [Open VSX Registry](https://open-vsx.org/extension/elijah-potter/harper).
-If you use Rust, Java, JavaScript, or any number of other programming languages, your comments may be ending up as part of your API's documentation. If that's the case, grammatical mistakes in your code could be down-ranking your site on search results and tarnishing your reputation for quality.
+## Installation
-Most importantly, Harper runs on-device and uses barely any memory at all. That means you can get feedback on your work in milliseconds, dramatically increasing your iteration speed.
+Open the Extensions view in your editor by selecting the Extensions icon in the Activity Bar or by using the `Ctrl+Shift+X` keyboard shortcut, then search for "Harper" and click "Install".
-Just search for "Harper" in the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=elijah-potter.harper) and hit install!
+## Commands
+
+| Command | ID | Description |
+| ------------------------------- | ------------------------------- | -------------------- |
+| Harper: Restart Language Server | `harper.languageserver.restart` | Restarts `harper-ls` |
+
+## Settings
+
+<!-- TODO: Link to the `harper-ls` configuration section here when it's done. -->
+
+The settings below are VS Code specific. You can head over to the `harper-ls` documentation to view other available settings.
+
+| Setting | Type | Default Value | Description |
+| ------------- | -------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `harper.path` | `string` | `""` | Optional path to a `harper-ls` executable to use. Primarily useful if the bundled binary doesn't work in your system like in immutable Linux distributions. |