Skip to content

docs(compat): clean up supported hardware references#2858

Merged
vpetersson merged 1 commit into
Screenly:masterfrom
nicomiguelino:docs/compat-cleanup
May 10, 2026
Merged

docs(compat): clean up supported hardware references#2858
vpetersson merged 1 commit into
Screenly:masterfrom
nicomiguelino:docs/compat-cleanup

Conversation

@nicomiguelino
Copy link
Copy Markdown
Contributor

@nicomiguelino nicomiguelino commented May 10, 2026

Issues Fixed

N/A

Description

  • Replace inline Pi OS compatibility list in README with a link to the supported hardware section on the website
  • Remove outdated Pi 1 / Pi Zero notes and balenaHub link
  • Add id="supported-hardware" to the heading in get-started.html to support the anchor link

Checklist

  • I have performed a self-review of my own code.
  • New and existing unit tests pass locally and on CI with my changes.
  • I have done an end-to-end test for Raspberry Pi devices.
  • I have tested my changes for x86 devices.
  • I added a documentation for the changes I have made (when necessary).

- Replace inline Pi OS compatibility list in README with a link to the website
- Remove Pi 1 note about pending installer fix
- Remove Pi 1 balenaHub link from installation options
- Drop Pi Zero/Model B mention from installation time note
- Add ID to "Supported hardware" heading in get-started.html
@nicomiguelino nicomiguelino self-assigned this May 10, 2026
@nicomiguelino nicomiguelino requested a review from Copilot May 10, 2026 18:47
@sonarqubecloud
Copy link
Copy Markdown

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Updates documentation to centralize “supported hardware” information on the website and removes outdated Raspberry Pi 1 / Pi Zero references.

Changes:

  • Added a stable #supported-hardware anchor on the website “Get Started” page.
  • Simplified README compatibility details to link to the website’s supported hardware section instead of duplicating a device/OS matrix.
  • Removed the Raspberry Pi 1 balenaHub image link and dropped the Pi Zero / Pi Model B “installation takes hours” note from the installation options doc.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.

File Description
website/layouts/_default/get-started.html Adds id="supported-hardware" to support deep-linking from other docs (e.g., README).
website/content/docs/installation-options.md Removes outdated Pi 1 balenaHub link and Pi Zero / Pi Model B install-time note.
README.md Replaces the inline Raspberry Pi OS compatibility list with a link to the website’s supported hardware section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
@nicomiguelino nicomiguelino marked this pull request as ready for review May 10, 2026 18:53
@nicomiguelino nicomiguelino requested a review from a team as a code owner May 10, 2026 18:53
Copy link
Copy Markdown
Contributor

@vpetersson vpetersson left a comment

Choose a reason for hiding this comment

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

Nice cleanup

@vpetersson vpetersson merged commit f239678 into Screenly:master May 10, 2026
8 checks passed
@nicomiguelino nicomiguelino deleted the docs/compat-cleanup branch May 10, 2026 19:06
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.

3 participants