Skip to content

docs: add roadmap#259

Merged
iparaskev merged 1 commit intomainfrom
add_roadmap
Mar 1, 2026
Merged

docs: add roadmap#259
iparaskev merged 1 commit intomainfrom
add_roadmap

Conversation

@iparaskev
Copy link
Contributor

@iparaskev iparaskev commented Feb 24, 2026

Summary by CodeRabbit

  • Documentation
    • Added comprehensive "Supported Platforms" section to README, clearly documenting current macOS full support and Windows alpha availability status.
    • Introduced new "Roadmap" section outlining the product's planned features and improvements including WebRTC backend migration, dynamic codec selection, custom key bindings, Linux support expansion, and Windows platform reintroduction.

@netlify
Copy link

netlify bot commented Feb 24, 2026

Deploy Preview for hoppdocs ready!

Name Link
🔨 Latest commit 2158c2f
🔍 Latest deploy log https://app.netlify.com/projects/hoppdocs/deploys/699e14dddbc54f000894dcda
😎 Deploy Preview https://deploy-preview-259--hoppdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai
Copy link

coderabbitai bot commented Feb 24, 2026

📝 Walkthrough

Walkthrough

The README.md is updated with two new informational sections: "Supported Platforms" documenting macOS (fully supported) and Windows (alpha), and "Roadmap" listing planned future features including WebRTC backend migration and Linux support.

Changes

Cohort / File(s) Summary
Documentation
README.md
Added "Supported Platforms" section indicating macOS full support and Windows alpha status. Added "Roadmap" section outlining planned features: WebRTC backend migration, dynamic codec selection, key bindings, Linux support, and Windows reintroduction.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Hop, hop, the roadmap unfolds,
Platforms documented, futures told,
macOS thrives, Windows awakens slow,
Linux awaits the seeds we'll sow! 🌱✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: add roadmap' accurately describes the main change—adding a roadmap section to the README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch add_roadmap

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
README.md (1)

28-31: Consider adding Linux as an explicitly unsupported/planned platform.

The "Supported Platforms" section currently omits Linux entirely. Users on Linux who encounter the section may be left uncertain about its status. A brief note (e.g., "Not yet supported – see Roadmap") would make the table of support complete at a glance. Based on learnings, cross-platform compatibility for macOS, Windows, and Linux is a stated project goal.

📝 Suggested addition
 ## Supported Platforms

 - **macOS** - Fully supported
 - **Windows** - Alpha (compiles but expect some bugs)
+- **Linux** - Not yet supported (see Roadmap)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 28 - 31, Add an explicit Linux entry to the
"Supported Platforms" section so readers aren't left uncertain; update the
"Supported Platforms" list (the header "Supported Platforms" and the bulleted
platform lines) to include a Linux line such as "Linux - Not yet supported /
Planned (see Roadmap)" or similar phrasing that clarifies its current status and
points to the roadmap for details.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 35: The phrase "WebRTC related" in the checklist item should be
hyphenated as a compound modifier; update the TODO text "- [ ] Move everything
WebRTC related from WebKit to our Rust backend (currently in progress)" to read
"- [ ] Move everything WebRTC-related from WebKit to our Rust backend (currently
in progress)" so the compound adjective is correct (refer to the exact checklist
line containing "WebRTC related").

---

Nitpick comments:
In `@README.md`:
- Around line 28-31: Add an explicit Linux entry to the "Supported Platforms"
section so readers aren't left uncertain; update the "Supported Platforms" list
(the header "Supported Platforms" and the bulleted platform lines) to include a
Linux line such as "Linux - Not yet supported / Planned (see Roadmap)" or
similar phrasing that clarifies its current status and points to the roadmap for
details.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a90871a and 2158c2f.

📒 Files selected for processing (1)
  • README.md


## Roadmap

- [ ] Move everything WebRTC related from WebKit to our Rust backend (currently in progress)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Fix compound-modifier hyphenation: WebRTC-related.

"WebRTC related" modifies "everything" and should be hyphenated as a compound adjective.

✏️ Proposed fix
-- [ ] Move everything WebRTC related from WebKit to our Rust backend (currently in progress)
+- [ ] Move everything WebRTC-related from WebKit to our Rust backend (currently in progress)
🧰 Tools
🪛 LanguageTool

[grammar] ~35-~35: Use a hyphen to join words.
Context: ...## Roadmap - [ ] Move everything WebRTC related from WebKit to our Rust backend ...

(QB_NEW_EN_HYPHEN)

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 35, The phrase "WebRTC related" in the checklist item
should be hyphenated as a compound modifier; update the TODO text "- [ ] Move
everything WebRTC related from WebKit to our Rust backend (currently in
progress)" to read "- [ ] Move everything WebRTC-related from WebKit to our Rust
backend (currently in progress)" so the compound adjective is correct (refer to
the exact checklist line containing "WebRTC related").

@iparaskev iparaskev merged commit 23e4153 into main Mar 1, 2026
16 checks passed
@iparaskev iparaskev deleted the add_roadmap branch March 1, 2026 22:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants