Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Quick Start Guide #203

Open
elijah-potter opened this issue Oct 4, 2024 · 2 comments
Open

Create a Quick Start Guide #203

elijah-potter opened this issue Oct 4, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@elijah-potter
Copy link
Collaborator

Much to my surprise, yesterday Harper was featured on console.dev. While I appreciate their praise, they informed us that our lack of a quick start guide is a major turn-off for many people.

I am proposing that we unify the somewhat disparate installation instructions and guides found throughout the repository into a single "Quick Start Guide", accessible from the README.

We would want to include instructions for the following editors/package managers:

  • Neovim with Mason
  • Neovim with external package manager
    • pacman
    • cargo
    • ...
  • Zed
  • Helix
  • Emacs
  • Visual Studio Code
  • Obsidian

The format of this quick start guide up to whoever picks up the ticket, but I'd inclined towards either a QUICKSTART.md file or a page on the website.

@elijah-potter elijah-potter added the documentation Improvements or additions to documentation label Oct 4, 2024
@grantlemons
Copy link
Contributor

Related:

This is fantastic. I'm considering setting up a Wiki page for miscellaneous configurations that people can copy/paste from. Would it be alright if I included yours?

Quick start guide could link to common configurations from community.

@grantlemons grantlemons pinned this issue Oct 6, 2024
@nyabinary
Copy link

Is there a way to use Harper in Firefox or anything like that? Or any plans for that (similar to LanguageTool)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants