Skip to content

Add device management script and update firmware support documentation#169

Open
Dia2809 wants to merge 5 commits into
PortsMaster:mainfrom
Dia2809:main
Open

Add device management script and update firmware support documentation#169
Dia2809 wants to merge 5 commits into
PortsMaster:mainfrom
Dia2809:main

Conversation

@Dia2809
Copy link
Copy Markdown
Contributor

@Dia2809 Dia2809 commented May 23, 2026

Summary

This PR adds tooling for managing device entries and updates documentation to reflect current firmware support status, particularly removing references to the discontinued JELOS firmware.
Key Changes
New Features

Added scripts/add_device.sh: Interactive bash script for adding new device entries to devices.json
    Prompts for device name, manufacturer, resolution, aspect ratio, supported firmwares, and notes
    Automatically calculates suggested aspect ratio from resolution using GCD
    Supports selecting from predefined lists or entering custom values
    Includes duplicate device detection before writing to JSON
    Provides colored output and preview before confirmation

Documentation Updates

FAQ Page Restructuring: Added tabbed interface to separate FAQ content from firmware support information
    New "Supported & Unsupported Firmwares" tab with detailed tables
    Lists actively supported firmwares: ArkOS, AmberELEC, ROCKNIX, muOS, Knulli, uOS/UnofficialOS, dArkOS
    Documents JELOS as discontinued with migration guidance to ROCKNIX

Firmware References: Removed JELOS from all device entries in devices.json and updated installation/porting guides
    Removed JELOS from 10+ device firmware lists
    Removed JELOS-specific installation paths from documentation
    Updated references to "CFW" terminology for consistency

Content Corrections:
    Fixed typos: "recommeded" → "recommended", "trough" → "through", "aswell" → "as well"
    Updated Java porting section with WestonPack Runtime information and working examples (Minecraft, Unciv, Mindustry)
    Removed outdated "(Currently Outdated)" note from supported devices section
    Improved formatting and consistency across FAQ and installation guides

Implementation Details

The device script uses Python 3 for JSON manipulation to ensure proper formatting and encoding
Color-coded terminal output for better UX (cyan headers, yellow prompts, green success, red errors)
Bash strict mode (set -euo pipefail) for reliability
Both source markdown files and compiled HTML files updated for consistency

claude and others added 5 commits May 22, 2026 23:53
- Fix typos: "trough"→"through", "aswell"→"as well", "runnning"→"running", "recommeded"→"recommended"
- Remove JELOS from all supported firmware lists (discontinued project)
- Add Bootstrap tabs to FAQ page with a new "Supported & Unsupported Firmwares" tab
- JELOS listed as unsupported with note to migrate to ROCKNIX

https://claude.ai/code/session_0193NVVCLGsYRyD4sZitY1Th
… (partial)

- Merge uOS and UnofficialOS into a single entry (same firmware)
- Mark uOS / UnofficialOS as partially supported
- Add dArkOS as a fully supported firmware

https://claude.ai/code/session_0193NVVCLGsYRyD4sZitY1Th
- Replace "no ports use Java" with the actual working ports: Minecraft, Unciv, Mindustry
- Explain WestonPack as the recommended approach for Java ports (provides JDK + display backend)
- Remove outdated JELOS reference from Java section

https://claude.ai/code/session_0193NVVCLGsYRyD4sZitY1Th
Interactive shell script that prompts for all device fields
(name, manufacturer, resolution, aspect ratio, firmwares, notes),
auto-suggests aspect ratio from resolution, supports multi-select
for firmwares, shows a preview before writing, and guards against
duplicate entries. Writes directly to devices.json via Python.

https://claude.ai/code/session_0193NVVCLGsYRyD4sZitY1Th
Add device management script and update firmware support documentation
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