Skip to content

docs: update Keyboard Shortcuts table with all implemented shortcuts - #1820

Open
chiragjangiir wants to merge 1 commit into
reframe-oss:mainfrom
chiragjangiir:fix/readme-keyboard-shortcuts-1779
Open

chiragjangiir wants to merge 1 commit into
reframe-oss:mainfrom
chiragjangiir:fix/readme-keyboard-shortcuts-1779

Conversation

@chiragjangiir

Copy link
Copy Markdown

Description

Resolves #1779.

The Keyboard Shortcuts table in README.md was previously incomplete and contained an inaccurate key combination:

  1. Listed Ctrl+Enter / Cmd+Enter for video export, whereas the implementation in src/hooks/useKeyboardShortcuts.ts listens for Ctrl/Cmd + Shift + E.
  2. Omitted the remaining active shortcuts implemented in src/hooks/useKeyboardShortcuts.ts and src/components/VideoEditor.tsx's KeyboardShortcutsPanel:
    • R (Reset all settings)
    • 1–9 (Switch preset by index)
    • I (Set trim in-point)
    • O (Set trim out-point)
    • ? (Toggle keyboard shortcuts panel)

Changes

  • Updated the table in README.md to accurately document all 9 keyboard shortcuts currently active in the application (Ctrl+Shift+E / Cmd+Shift+E, Space, M, R, Escape, 1–9, I, O, ?).

Verification

  • Verified each shortcut key combination against src/hooks/useKeyboardShortcuts.ts, src/components/VideoPreview.tsx, and src/components/VideoEditor.tsx.
  • Ran bun run lint (passed with 0 errors).

@netlify

netlify Bot commented Oct 21, 2026

Copy link
Copy Markdown

👷 Deploy request for reframe-os pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit f8fb55d

@github-actions

Copy link
Copy Markdown
Contributor

👋 Thanks for your PR, @chiragjangiir!

Welcome to Reframe — a browser-based video editor built for everyone 🎬

What happens next

  1. 🤖 Automated checks — build & TypeScript typecheck will run automatically
  2. ✅ Vercel preview — a preview deployment will be created (requires maintainer authorization for fork PRs)
  3. 👀 Code review — a maintainer will review your changes
  4. 🚀 Merge — once approved, your PR will be merged!

Quick checklist

  • PR title follows Conventional Commits (e.g. feat: add dark mode)
  • Linked the issue this PR closes (e.g. Closes #123)
  • Tested the changes locally (bun run dev)
  • Build passes (bun run build)

Useful links

Happy coding! 🎉

@github-actions

Copy link
Copy Markdown
Contributor

✅ PR Format Check Passed — @chiragjangiir

Basic format checks passed. A maintainer will review your code changes.

This does not mean the PR is approved — it just means the format is correct.

@github-actions github-actions Bot added level:beginner Beginner level - 20 pts type:docs Documentation labels Oct 21, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

level:beginner Beginner level - 20 pts type:docs Documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] README's Keyboard Shortcuts table lists only 4 of the 8 shortcuts that actually exist

1 participant