Skip to content

docs: restructure the README and list each backend's packages - #157

Merged
avifenesh merged 5 commits into
mainfrom
docs/backend-packages
Oct 26, 2026
Merged

avifenesh merged 5 commits into
mainfrom
docs/backend-packages

Conversation

@avifenesh

@avifenesh avifenesh commented Oct 25, 2026 •

Copy link
Copy Markdown
Collaborator

README rework for scanning:

  • Hero: a gallery of all six backends, captured from real hidden workspaces on one host (replaces the old screenshot of a terminal transcript).
  • Section nav under the hero; install as three numbered steps; the backend overview, per-backend packages and the pinned cosmic-comp install in one place.
  • Long reference material (GNOME input details, CDP attach, install.sh flags, group-drop requirements, dogfood helper) moved into collapsible sections; validation probes in one table.
  • Security split into who sets boundaries, what a sandboxed app sees (with the X11 caveat as a warning callout) and cleanup.
  • No em dashes; facts unchanged except the cargo pin example (v0.2.0 -> v0.5.1).

Checked rendered on GitHub at 1400x1050 in light and dark themes.


Note

Low Risk
Documentation-only README restructuring with a minor cargo install version example update; no code or security behavior changes.

Overview
README overhaul for faster scanning, with no runtime or API changes.

The hero now uses centered HTML, an npm badge, anchor nav, and assets/backends.png (six backends) instead of the old viewer QA screenshot. Install is three steps (system packages, binary via install.sh / npm / cargo, MCP registration); Codex/install.sh detail lives in a collapsible.

Desktop backends get a comparison table (session, stack, scale, GPU), a per-backend Ubuntu package list, scale/coordinate notes, and per-backend notes in <details>. Security is renamed and split into boundary ownership, what sandboxed apps see (with a GitHub warning on X11 vs Wayland), and terminal cleanup. Validation probes, CDP attach, group-drop requirements, and browser-session dogfood are consolidated into tables or collapsibles. The cargo pin example updates v0.2.0 → v0.5.1; other facts are reorganized, not rewritten.

Reviewed by Cursor Bugbot for commit 741fa32. Configure here.

Copilot AI balanced review requested due to automatic review settings October 25, 2026 23:56

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@avifenesh

Copy link
Copy Markdown
Collaborator Author

Self-review: docs only. Each package was checked with apt-cache policy and dpkg -S against the binaries the backend's doctor check requires (kbuildsycoca6 -> libkf6service-bin, kscreen-doctor -> libkscreen-bin, xrdb -> x11-xserver-utils, gsettings -> libglib2.0-bin). The cosmic-comp URLs and sha256 sums match scripts/cosmic_probe.Dockerfile.

@cursor

cursor Bot commented Oct 25, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 054cb473-2556-42b6-b3d0-0106d696ad28)

@revuto-review revuto-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is an auto review done by revuto.


The COSMIC installation example does not enforce its checksum check before installing packages.

Comment thread README.md Outdated
Copilot AI balanced review requested due to automatic review settings October 26, 2026 00:07
@cursor

cursor Bot commented Oct 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 05d62d80-06d3-4a4e-b745-54f8737146f4)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@revuto-review revuto-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is an auto review done by revuto.


The COSMIC installation example still installs downloaded packages even when checksum verification fails.

Comment thread README.md Outdated
Copilot AI balanced review requested due to automatic review settings October 26, 2026 00:15

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@cursor

cursor Bot commented Oct 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: 8fb2685e-20e4-4d4a-9df3-0628889edaa6)

@revuto-review revuto-review Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

This is an auto review done by revuto.


The COSMIC installation example still installs downloaded packages even when checksum verification fails.

Comment thread README.md Outdated
Copilot AI balanced review requested due to automatic review settings October 26, 2026 00:16
@cursor

cursor Bot commented Oct 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: ce58d568-b155-404e-8863-b3fd300d1674)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@avifenesh avifenesh changed the title docs: list the packages each backend needs docs: restructure the README and list each backend's packages Oct 26, 2026
@avifenesh

Copy link
Copy Markdown
Collaborator Author

Self-review at 19f1712: every fact from the old README is kept (diffed section by section); anchors in the nav and cross-links resolve; the gallery PNG is 85 KB. assets/viewer-website-qa.png stays in the repo in case anything links to it directly.

Copilot AI balanced review requested due to automatic review settings October 26, 2026 00:55
@cursor

cursor Bot commented Oct 26, 2026

Copy link
Copy Markdown

Bugbot couldn't run - usage limit reached

Bugbot is counted against Cursor usage for this user or team, and this run hit a usage or spend limit.

A user or team admin can review and increase usage limits in the Cursor dashboard.

(requestId: eeed71ee-71fe-4964-a537-d90aa4e761fd)

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing. Review the Copilot code review billing settings.

@avifenesh

Copy link
Copy Markdown
Collaborator Author

Revuto reached its 3-round cap on this PR. Its only finding (gate the cosmic-comp install on checksum verification) is fixed in 741fa32 and tested on both paths; all review threads are resolved and CI is green.

@avifenesh
avifenesh merged commit 3234d7f into main Oct 26, 2026
9 of 10 checks passed
@avifenesh
avifenesh deleted the docs/backend-packages branch October 26, 2026 01:05
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