Endless OS documentation#723
Conversation
Part of flipcomputing#705
📝 WalkthroughWalkthroughAdded ChangesEndless OS documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/endless.md`:
- Line 30: Update the Flock XR link in docs/endless.md so it points directly to
the project’s contact, support, or issue-reporting destination rather than the
general homepage. Keep the surrounding Endless OS guidance unchanged.
- Around line 21-23: Expand the “Installing Flock XR as a Web App” section with
concrete Chromium and Epiphany menu steps, and state that Flock XR must be
opened online once before it can be used offline. Keep the existing Endless OS
context and screenshot reference.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 87d4eb8d-7556-4e01-afd8-1e46740a69f5
⛔ Files ignored due to path filters (4)
docs/images/EndlessApplications.pngis excluded by!**/*.pngdocs/images/EndlessChromium.pngis excluded by!**/*.pngdocs/images/EndlessEpiphany.pngis excluded by!**/*.pngdocs/images/EndlessWebApp.pngis excluded by!**/*.png
📒 Files selected for processing (1)
docs/endless.md
| ### Installing Flock XR as a Web App | ||
|
|
||
| From both Chromium and Epiphany, on Endless OS, it is possible to install Flock XR as a web application. This app can then be used without an Internet connection, as shown in the following screenshot. |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Add the actual web-app installation steps.
This section only states that Chromium and Epiphany can install Flock XR, so readers still do not know which menu commands to use or whether the app must be loaded online once before offline use. Document the concrete steps and any first-run/network requirement.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/endless.md` around lines 21 - 23, Expand the “Installing Flock XR as a
Web App” section with concrete Chromium and Epiphany menu steps, and state that
Flock XR must be opened online once before it can be used offline. Keep the
existing Endless OS context and screenshot reference.
|
|
||
| Flock XR’s basic functionality has been tested on Endless OS using both of the browsers which come pre-installed with the distribution. That is, we tested Flock on Chromium and on GNOME Web (Epiphany). We found that Flock XR functioned well on both, with better compatibility being found on Chromium, so we recommend using Chromium to run Flock XR on Endless OS. | ||
|
|
||
| If you find any issues using Flock XR on Endless OS, let us know at [Flock XR](https://flockxr.com/). |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win
Link directly to the issue-reporting channel.
The current link opens the general Flock XR homepage, which leaves users to discover where to report an Endless OS problem. Link directly to the project’s contact, support, or issue-reporting destination instead. (flockxr.com)
🧰 Tools
🪛 LanguageTool
[style] ~30-~30: Consider using a different verb to strengthen your wording.
Context: ...to run Flock XR on Endless OS. If you find any issues using Flock XR on Endless OS...
(FIND_ENCOUNTER)
[style] ~30-~30: Consider using polite language here.
Context: ...ny issues using Flock XR on Endless OS, let us know at Flock XR.
(INSERT_PLEASE)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/endless.md` at line 30, Update the Flock XR link in docs/endless.md so
it points directly to the project’s contact, support, or issue-reporting
destination rather than the general homepage. Keep the surrounding Endless OS
guidance unchanged.
2 participants
Summary by CodeRabbit