diff --git a/packages/web/src/routes/docs/contributors/dictionary/+page.md b/packages/web/src/routes/docs/contributors/dictionary/+page.md index 3de8d652..f265a485 100644 --- a/packages/web/src/routes/docs/contributors/dictionary/+page.md +++ b/packages/web/src/routes/docs/contributors/dictionary/+page.md @@ -4,9 +4,9 @@ title: Updating the Curated Dictionary The curated dictionary is the English dictionary Harper uses as reference internally when analyzing or modifying English text. It is common, especially with technical language, to come across words that are not in this dictionary. -If this happens to you, please open a PR to get it in. +If this happens to you, please open a PR to get them in. -PR [#343](https://github.com/Automattic/harper/pull/343) is a great example of what is described here. +PR [#343](https://github.com/Automattic/harper/pull/343) is a practical example of the ideas described here. There are two files you need to worry about. [`harper-core/dictionary.dict`](https://github.com/Automattic/harper/blob/master/harper-core/dictionary.dict) and [`harper-core/affixes.json`](https://github.com/Automattic/harper/blob/master/harper-core/affixes.json). diff --git a/packages/web/src/routes/docs/harperjs/introduction/+page.md b/packages/web/src/routes/docs/harperjs/introduction/+page.md index f2cc9b9e..86f1289d 100644 --- a/packages/web/src/routes/docs/harperjs/introduction/+page.md +++ b/packages/web/src/routes/docs/harperjs/introduction/+page.md @@ -8,7 +8,7 @@ If you're a developer, odds are that you are using JavaScript or TypeScript on a Your project probably has a least a little bit of either. Furthermore, a plurality of focused authorship happens inside either a web browser or an [Electron-based app](https://www.electronjs.org/). -Given this, we wanted to create an environment where trivial to integrate fantastic grammar checking into web applications. +Given this, we wanted to create an environment where it would be trivial to integrate fantastic grammar checking into web applications. That's why we created `harper.js`. Today, it serves as the foundation for our [Obsidian plugin](/docs/integrations/obsidian) and our [website](/). diff --git a/packages/web/src/routes/docs/harperjs/linting/+page.md b/packages/web/src/routes/docs/harperjs/linting/+page.md index 082b4510..680d1e1f 100644 --- a/packages/web/src/routes/docs/harperjs/linting/+page.md +++ b/packages/web/src/routes/docs/harperjs/linting/+page.md @@ -15,11 +15,11 @@ Notice how every method returns a `Promise<...>`. @code(../../../../../../harper.js/src/Linter.ts) -The `LocalLinter` will instantiate and prepare Harper's WebAssembly module asynchronously, but notably **in the same event loop**. +The `LocalLinter` will instantiate and prepare Harper's WebAssembly module asynchronously, but **in the same event loop**. This can result in high [LCP](https://developer.mozilla.org/en-US/docs/Glossary/Largest_contentful_paint), so this implementation is only recommended in situtations where the event loop will not be doing other latency-sensitive things. In other words: the `LocalLinter` is not for the web. The `WorkerLinter`, on the other hand, will instantiate and prepare Harper's WebAssembly module inside a [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API), which means it will **not** block the event loop. This is recommended for interactive web applications. -[Visit our page about CDNs](./CDN) to see an example of the `WorkerLinter` in action. +[Visit our page about CDNs](./CDN) to see an example of the `WorkerLinter` in action, or [the page about Node.js](./node) for the `LocalLinter`. diff --git a/packages/web/src/routes/docs/integrations/obsidian/+page.md b/packages/web/src/routes/docs/integrations/obsidian/+page.md index fbe378d9..0bfb5d5d 100644 --- a/packages/web/src/routes/docs/integrations/obsidian/+page.md +++ b/packages/web/src/routes/docs/integrations/obsidian/+page.md @@ -2,16 +2,16 @@ title: Obsidian --- +![A screenshot of Obsidian with Harper installed](/images/obsidian_screenshot.webp) + [Obsidian](https://obsidian.md/) is a popular Markdown editor and [Zettelkasten](https://en.wikipedia.org/wiki/Zettelkasten) knowledge vault. Its extensive plugin ecosystem makes it an attractive choice for note-taking students and documenting professionals. -While one of main features of Obsidian is privacy, server-side LanguageTool is one of the most popular plugins. -Harper aims to replace LanguageTool by being faster, better and entirely private. +While one of main features of Obsidian is privacy, a server-side LanguageTool plugin is one of the most popular on the platform. +Harper aims to replace LanguageTool by being faster, better, and entirely private. ## Installation -![A screenshot of Obsidian with Harper installed](/images/obsidian_screenshot.webp) - To add Harper to [Obsidian](/obsidian), just install the community plugin. More specifically, go to Obsidian's settings and click "Community Plugins." You may be asked to enable them.