Offline, privacy-first grammar checker. Fast, open-source, Rust-powered
docs: final updates and corrections
Matthew Espinoaad2f16ea155
diff --git a/packages/web/src/routes/docs/contributors/visual-studio-code/+page.md b/packages/web/src/routes/docs/contributors/visual-studio-code/+page.mdindex 2d262da44..700068ddb 100644--- a/packages/web/src/routes/docs/contributors/visual-studio-code/+page.md+++ b/packages/web/src/routes/docs/contributors/visual-studio-code/+page.md@@ -6,7 +6,7 @@ This document details how to develop the Visual Studio Code extension locally. I## Notes-- The extension code and its tests live in the `src` directory. Most changes you'll need to make will be there.+- The extension code and its tests live in the `packages/vscode-plugin/src` directory. Most changes you'll need to make will be there.- VS Code can only pickup the tasks and launch configurations set in `packages/vscode-plugin/.vscode` if this directory, `packages/vscode-plugin`, not the root of the Harper repository, is open.- You can look at the project's [`justfile`](https://github.com/Automattic/harper/blob/master/justfile) to see exactly what running the `just` recipes below do.diff --git a/packages/web/src/routes/docs/integrations/language-server/+page.md b/packages/web/src/routes/docs/integrations/language-server/+page.mdindex 344a70b48..6f8d34f96 100644--- a/packages/web/src/routes/docs/integrations/language-server/+page.md+++ b/packages/web/src/routes/docs/integrations/language-server/+page.md@@ -62,7 +62,7 @@ nix shell 'nixpkgs#harper'### Cargo-If you have Rust installed, `harper-ls` is in [crates.io](https://crates.io/crates/harper-ls), so you can simply run:+If you have Rust installed, `harper-ls` is on [crates.io](https://crates.io/crates/harper-ls), so you can simply run:```bashcargo install harper-ls --locked@@ -112,14 +112,14 @@ We _do_ take pull requests or issues for adding words to the static dictionary.## Code Actions-The examples below assume that you have misspelled "error" as "errorz" and have selected it to apply a code action to it.+`harper-ls` has code actions that help in quickly dealing with spelling or grammar errors you encounter. The examples below assume that you have misspelled "contained" as "containes" and have selected it to apply a code action to it.-| Code Action or Command | Description | Example |-| ---------------------- | ----------------------------------------------------- | ---------------------------------------- |-| Quick Fixes | Suggests fixes for the selected lint | `Replace with: "error"` |-| `HarperIgnoreLint` | Ignores selected lint for the duration of the session | `Ignore Harper error.` |-| `HarperAddToUserDict` | Adds selected word to the user dictionary | `Add "errorz" to the global dictionary.` |-| `HarperAddToFileDict` | Adds selected word to a file-local dictionary | `Add "errorz" to the file dictionary.` |+| Code Action or Command | Description | Example |+| ---------------------- | ---------------------------------------------------------- | ------------------------------------------- |+| Quick Fixes | Suggests fixes for the selected error | `Replace with: "contained"` |+| `HarperIgnoreLint` | Ignores the selected error for the duration of the session | `Ignore Harper error.` |+| `HarperAddToUserDict` | Adds the selected word to the user dictionary | `Add "containes" to the global dictionary.` |+| `HarperAddToFileDict` | Adds the selected word to a file-local dictionary | `Add "containes" to the file dictionary.` |## Configuration@@ -216,7 +216,7 @@ These configs are under the `markdown` key:| Config | Type | Default Value | Description || -------------------- | ------------------------------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |-| `diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"hint"` | Configure how severe you want diagnostics to appear in your editor |+| `diagnosticSeverity` | `"error"`, `"hint"`, `"information"`, `"warning"` | `"hint"` | Configures how severe diagnostics appear in your editor || `isolateEnglish` | `boolean` | `false` | In documents that are a mixture of English and another language, only lint English text. This feature is incredibly new and unstable. Do not expect it to work perfectly. |## Supported Languagesdiff --git a/packages/web/src/routes/docs/integrations/neovim/+page.md b/packages/web/src/routes/docs/integrations/neovim/+page.mdindex c519a0eea..e4eb21a52 100644--- a/packages/web/src/routes/docs/integrations/neovim/+page.md+++ b/packages/web/src/routes/docs/integrations/neovim/+page.md@@ -12,7 +12,7 @@ Our Neovim integration is powered by [`harper-ls`](./language-server).Below is an example config using nvim-lspconfig where everything is set to their default values:-```lua+```lua title=inti.lualspconfig.harper_ls.setup {settings = {["harper-ls"] = {