docs(jetson): reorganize the Jetson docs around setup and developer paths - #61
Merged
Conversation
…aths Group each carrier's pages into Set Up / Using ARK-OS / Hardware Reference / Developer Guide instead of ~20 flat siblings, and add a setup flow that covers connecting and getting online in one sequence. Move the Jetson PABs and the avionics accessories out of the vestigial products/ tree, consolidate the triplicated ARK-OS and USB adapter pages into shared sections, and add .gitbook.yaml with redirects for all 58 moved URLs.
GitBook builds a page URL from SUMMARY.md nesting plus the site section slug, not the repo directory layout. The first pass keyed redirects off file paths, which missed both the section prefix and every page that changed URL by gaining a nav parent (pinout is now under hardware/, flashing-guide under developer/). Derive old and new URLs from the nav on both sides and emit the 58 that changed, each with and without the section prefix.
Drop the "no Linux required" clause, the "always works" opener on the connect pages, and link descriptors that only restate the page title.
This was referenced Aug 14, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Restructures the three Jetson carriers' docs around the two ways people actually use them: a bundle that arrives preflashed and is driven from ARK-UI, and a bare board someone flashes and SSHes into. Follows up #53, which audited these pages for correctness and left the structural work as named follow-ups.
Problem
Each carrier exposed about twenty flat sibling pages with no grouping, so a bundle owner hit Flashing Guide third and Pinout fifth. Setup knowledge was spread across four pages — SSH over USB in both getting-started and connections, WiFi-over-CLI buried inside the serial console page — and nothing linked them as a sequence.
Six pages were byte-identical across all three carriers, or differed only by a blank line and an asset path: 18 files carrying 6 pages. The Pi copy of
services.mdhad already drifted to 673 words against the Jetson's 320.The Jetson PABs and three accessories also sat under a vestigial
products/prefix while every other family is top-level, and with no.gitbook.yamlthere were no redirects to catch a move.Solution
Each carrier now groups into Overview → Set Up → Using ARK-OS → Hardware Reference → Developer Guide, with the Overview routing on the one question that splits the two paths: did this arrive preflashed?
Set Up is a real sequence — Connect, then Get Online — absorbing the connection material previously split across getting-started, connections, and the console pages. WiFi-over-CLI moves out of the console page into Get Online, next to the ARK-UI route.
ARK-OS overview, services, and the apt hold-back page move to a shared top-level
ark-os/section; the nine USB adapter pages become oneknowledge-base/usb-peripherals.md. Per-carrier page counts drop from ~21 to ~19 while the duplication behind them goes from 18 files to 4.products/is gone — the PABs are atflight-controller/jetson-pabs/, the accessories ataccessories/..gitbook.yamladds redirects for all 58 moved URLs.Verified mechanically: all 826 relative links resolve, all 263 pages appear in SUMMARY with none orphaned, and every redirect target exists.
The Pi products are deliberately untouched so draft #54 still lands cleanly. Consolidating its ARK-OS copies into the new shared section is the natural follow-up.