Skip to content

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

doc: clarify instructions and project status (#2453)

Elijah Potter66bd28eda88e
diff --git a/harper-core/README.md b/harper-core/README.md
index 42b177ca1..a5f2ade34 100644
--- a/harper-core/README.md
+++ b/harper-core/README.md
@@ -1,10 +1,15 @@
# `harper-core`
-`harper-core` is the fundamental engine behind [Harper](https://writewithharper.com), the grammar checker for developers.
+`harper-core` is the fundamental engine behind [Harper](https://writewithharper.com), the private grammar checker.
-`harper-core` _is_ [available on `crates.io`](https://crates.io/crates/harper-core). However, improving the API is not currently a high priority.
+`harper-core` is [available on `crates.io`](https://crates.io/crates/harper-core) to enable Rust engineers to integrate high-quality grammar checking directly into their apps and workflows.
Feel free to use `harper-core` in your projects.
-If you run into issues, create a pull request.
+If you run into problems with the code, open an issue or, even better, create a pull request.
+We are also happy to chat with you on [Discord](https://discord.com/invite/JBqcAaKrzQ).
+
+[The documentation for `harper-core` is available online.](https://docs.rs/harper-core/latest/harper_core/)
+
+If you would prefer to run Harper from inside a JavaScript runtime, [we have a package for that as well.](https://www.npmjs.com/package/harper.js)
## Example
@@ -35,3 +40,8 @@ for lint in lints {
`concurrent`: Whether to use thread-safe primitives (`Arc` vs `Rc`). Disabled by default.
It is not recommended unless you need thread-safely (i.e. you want to use something like `tokio`).
+
+## Other Relevant Packages
+
+- [`harper-ls`](https://crates.io/crates/harper-ls)
+- [`harper-tree-sitter`](https://crates.io/crates/harper-tree-sitter)
diff --git a/packages/web/src/routes/docs/contributors/environment/+page.md b/packages/web/src/routes/docs/contributors/environment/+page.md
index 3c1cd4695..fbd75aa02 100644
--- a/packages/web/src/routes/docs/contributors/environment/+page.md
+++ b/packages/web/src/routes/docs/contributors/environment/+page.md
@@ -9,6 +9,7 @@ In that case, Harper follows all of the standard conventions for Rust projects,
If you intend to work on the Chrome extension, Obsidian plugin, or certain other projects, you'll need the full environment set up.
To use _all_ the tooling we use to build and debug Harper, you'll need the following programs available in your `$PATH`.
+Please read the manuals for each tool for instructions on how to install it.
For Nix users, we provide a [Nix development shell](#Nix-development-shell) to setup all the necessary tooling automatically.
- [`just`](https://github.com/casey/just)
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.md
index 1b6b615c7..323f13671 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
@@ -12,7 +12,7 @@ This document details how to develop the Visual Studio Code extension locally. I
## Prerequisites
-- Make sure to [set up your environment](./environment). Be sure to run `just setup` as the guide recommends, or at least `pnpm install`, to make sure the extension's dependencies are installed.
+- Make sure to [set up your environment](./environment). Be sure to run `just setup` as the guide recommends to make sure the extension's dependencies are installed.
- Install the [recommended extension](https://github.com/Automattic/harper/blob/master/packages/vscode-plugin/.vscode/extensions.json), [`connor4312.esbuild-problem-matchers`](https://marketplace.visualstudio.com/items?itemName=connor4312.esbuild-problem-matchers), so VS Code can understand and run esbuild tasks.
- Before running or testing the extension using VS Code's Debugger, make sure you have `harper-ls` in `packages/vscode-plugin/bin`. You can either manually create the directory, compile `harper-ls`, and put it there or you can run `just test-vscode` or `just package-vscode` which will do that for you.
@@ -36,6 +36,9 @@ just test-vscode
### Using VS Code's Debugger
+Remember: VS Code can only pick up the tasks and launch configurations set in `packages/vscode-plugin/.vscode` if `packages/vscode-plugin`, not the root of the Harper repository, is open.
+That means you need to manually open VS Code in the `vscode-plugin` directory yourself.
+
You may also follow these steps to run the tests through your VS Code installation.
1. Open the Run and Debug view by selecting it from the Activity Bar or by pressing `Ctrl+Shift+D`.