Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Docs: shortcuts reference generated from the shortcut registry

Open
  • Is something wrong?
#49 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
78/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
electron, javascript, node.js
Domain
developer-experience, documentation

Research direction

Read src/renderer/shortcuts.js to understand the default registry, then inspect the project’s existing scripts and unit test setup. Implement the generator at scripts/gen-shortcuts-doc.js, generate docs/SHORTCUTS.md, link it from the README, and add a test that detects stale output. Run node scripts/gen-shortcuts-doc.js twice to check idempotence and run npm run test:unit; done means both acceptance criteria pass.

Written by the indexing model from the issue text.

Description

area:ux documentation good first issue help wanted

Context
Shortcuts are declared in src/renderer/shortcuts.js (id, label, keys, global). Users can rebind them, but the defaults are not documented anywhere outside the app.

Proposed scope

  • Add scripts/gen-shortcuts-doc.js that reads the default registry and writes docs/SHORTCUTS.md as a table (action, default keys, whether it works while a terminal has focus).
  • Commit the generated file and link it from the README.
  • Add a unit test that fails when the committed file is stale relative to the registry.

Acceptance criteria

  • node scripts/gen-shortcuts-doc.js is idempotent.
  • The staleness test fails if a shortcut is added without regenerating.

How to get started

  1. Read CONTRIBUTING.md, run npm install && npm start.
  2. Comment here so nobody duplicates the work; ask questions in the thread, we are happy to point you at the right file.
  3. Open a PR that references this issue. Run npm test (or npm run test:unit) first.
Dominant language
JavaScript
Stars
0
Forks
0
No merged PRs in 30d

Getting set up

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.

More from adaumsilva/OrchestrAI

All issues in adaumsilva/OrchestrAI

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.