Skip to content

Commit

Permalink
docs: created initial "Frequently Asked Questions" page
Browse files Browse the repository at this point in the history
  • Loading branch information
elijah-potter committed Jan 3, 2025
1 parent e7c5a27 commit 10ea21f
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
22 changes: 22 additions & 0 deletions packages/web/src/routes/docs/faq/+page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Frequently Asked Questions
---

## Is There a Chrome or Firefox Extension?

**Short answer**: not yet.

**Long answer:** at the time of writing, we've just released our first version of `harper.js` ([documentation here](./harperjs/introduction)), which will make it significantly easier to build such a product.
That said, our road map has higher priority items at the moment, so don't expect the offical Harper maintainers to make an attempt in the near future.

If you're interested in trying to make one, let us know how it goes.
We might be able to help.

## Why Doesn't Harper Support My Programming Language?

Harper (particularly `harper-ls`) tries to support a wide variety of programming languages.
If one is missing, it's probably because we haven't had time to get to it yet.
We are entirely open to PRs that add support.

If you just want to be able to run grammar checking on your code's comments, it's actually quite straightforward.
You can use [this PR as a model for what to do](https://github.com/Automattic/harper/pull/332).
4 changes: 4 additions & 0 deletions packages/web/vite.config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,10 @@ export default defineConfig({
}
]
},
{
title: 'FAQ',
to: '/docs/faq'
},
{
title: 'Rules',
to: '/docs/rules'
Expand Down

0 comments on commit 10ea21f

Please sign in to comment.