Skip to content

docs(pi): audit and rewrite Pi6X Flow and Just a Pi docs - #54

Draft
dakejahl wants to merge 3 commits into
mainfrom
docs/pi-carrier-audit
Draft

docs(pi): audit and rewrite Pi6X Flow and Just a Pi docs#54
dakejahl wants to merge 3 commits into
mainfrom
docs/pi-carrier-audit

Conversation

@dakejahl

@dakejahl dakejahl commented Jul 31, 2026

Copy link
Copy Markdown
Collaborator

Summary

Audits the Pi6X Flow and Just a Pi docs against the current ARK-OS, and points both products at the shared ARK-OS section introduced by #61.

Problem

Both products' ARK Services pages described the retired systemd user-service install and the removed hotspot-updater service, with dead config links and a stale firmware-update screenshot. Just a Pi had no ARK-OS docs at all and a literal TODO where the ships-with state should be, and its flashing guide never mentioned the ark_pi_image golden image that bundles actually ship with. Both flashing guides steered users to Bookworm with a "Trixie not yet verified" warning that predates the trixie deb.

This PR originally added per-product ARK-OS pages to both Pi products. #61 has since consolidated the three Jetson copies into a shared ark-os/ section, so that would have taken the duplication from four copies to six.

Solution

ark-os/ now covers Jetson and Pi rather than Jetson alone. The service set is identical across all five carriers — only the hostname, the device user (jetson or pi), and the dds-agent serial node differ, so those are stated inline instead of forked into separate pages. The Pi-only packaging split (ark-os-pi-trixie / ark-os-pi-bookworm) and the Jetson-only CLI tools are called out where they apply.

Each Pi product gets a short Using ARK-OS landing page carrying its hostname, screenshot, and carrier-specific links, matching the pattern the Jetson carriers use.

The rest of the audit is unchanged: Just a Pi getting-started documents the pre-imaged bundle state, its flashing guide leads with the ark_pi_image golden image, and the Pi6X firmware page drops the hardcoded v1.15.0 link for the releases page and flash_firmware.sh.

Two URLs change (the Pi6X ark-services pages) and both have redirects. All 860 relative links resolve and every page is reachable from SUMMARY.

Port the Jetson-audit treatment to the Pi products:

- ARK-OS pages rebuilt for the deb-based reality: system-level services,
  current service list (go2rtc, pointperfect; hotspot-updater removed),
  install/update via install_ark_os.sh, CLI tools, Pi-flavored UI
  screenshots; Just a Pi gains its missing ARK-OS section
- Just a Pi getting-started resolves the bundle-state TODO: bundles ship
  pre-imaged from ark_pi_image with ARK-OS installed; first-boot hotspot
  fallback documented
- Just a Pi flashing guide leads with the ark_pi_image golden image;
  manual Raspberry Pi Imager flow kept as the fallback
- Stale 'Trixie not verified' hints replaced: ARK-OS ships bookworm and
  trixie debs and the installer picks automatically
- Pi6X firmware page: current UI screenshot, flash_firmware.sh on PATH,
  un-pin the hardcoded v1.15.0 download link
- Reorder both products: setup flow first, reference last
@dakejahl
dakejahl marked this pull request as draft July 31, 2026 23:36
@dakejahl

Copy link
Copy Markdown
Collaborator Author

Converted to draft per Alex — holding until first-class pi6x-cm4 support lands in ark_pi_image (ARK-Electronics/ark_pi_image#8). When that merges, before marking this ready: lead the Pi6X Flow flashing guide with the golden image too (./build.sh --target pi6x-cm4 --provision + ./flash.sh, per that PR's new --target flow), demote the manual Imager/config.txt path to the fallback, and mirror the Just a Pi bundle wording. The rest of this PR (ARK-OS pages, screenshots, Trixie-hint fixes, reordering) is independent of that repo work.

Rebase onto the reorganized docs: instead of adding per-product ARK-OS
pages, generalize ark-os/ to cover Jetson and Pi and give each Pi product
a Using ARK-OS landing page.

The service set is identical across all five carriers; only the hostname,
the device user, and the dds-agent serial node differ, so those are now
stated inline. Redirects cover the two Pi6X ark-services URLs.
@dakejahl

Copy link
Copy Markdown
Collaborator Author

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.

1 participant