vercel / vercel/hyper

Docs confusion

Open
#3,425 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
44.7k
Forks
3.6k
Avg merge
21m
Merged PRs (30d)
1

Description

(Arch Linux)

Hyper uses ~/.config/Hyper/config.json instead of ~/.config/Hyper/.hyper.js. I could not install plugin just editing .hyper.js and reloading (only with hyper i which edited config.json) so example from the main page does not work. Even hyper i command is not documented anywhere on the website except the video.

The very basic functionality is not documented, examples from the official website do not work. Is that what you call a good user experience?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the main-page plugin example and the website references to .hyper.js, comparing them with the Arch Linux behavior described in the issue. Document the current config.json workflow and the hyper i command, with examples that work as described.

Written by the indexing model from the issue text.

Assessment

Tech stack
arch-linux
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.