Repository navigation
docs: fix doc paths left stale by the docs restructure - #294
Merged
jewbetcha merged 1 commit intoOct 7, 2026
Merged
Conversation
The docs restructure (45d3b4d) moved the flat docs/*.md guides into sectioned directories, but several user-facing pointers still named the old files and have been 404s since: - hardware-help issue template: raspberry-pi-setup, sound-trigger-wiring, kld7-troubleshooting - scripts/setup/setup.sh: raspberry-pi-setup (x4), cloud-sync (x2) - scripts/setup/setup_kld7_devices.sh, scripts/analysis/capture_kld7_radc.py: raspberry-pi-setup - scripts/analysis/replay_spin_dechirp.py: spin-dechirp-replay - scripts/vision/test_yolo_detection.py: yolo-performance-tuning Point each at the page's current location. Two section pointers in setup.sh were updated to headings that exist in the new page. CLAUDE.md and AGENTS.md already linked to the right file; only the visible link text was stale. The one remaining reference, a warning string in src/openflight/kld7/ radc.py, is left for a code PR so this one stays docs-only.
jewbetcha
approved these changes
Oct 7, 2026
8 of 10 tasks
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
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.
What does this PR do?
Repoints every user-facing reference to a flat
docs/*.mdguide that no longer exists at that path:docs/raspberry-pi-setup.mddocs/setup/raspberry-pi.mdscripts/setup/setup.sh,setup_kld7_devices.sh,capture_kld7_radc.pydocs/sound-trigger-wiring.mddocs/build/sound-trigger.mddocs/kld7-troubleshooting.mddocs/legacy/troubleshooting.mddocs/cloud-sync.mddocs/using/cloud-sync.mdscripts/setup/setup.shdocs/spin-dechirp-replay.mddocs/development/spin-replay.mdscripts/analysis/replay_spin_dechirp.pydocstringdocs/yolo-performance-tuning.mddocs/development/camera-yolo.mdscripts/vision/test_yolo_detection.pyTwo section pointers in
setup.sh("→ Radar Setup", "(K-LD7 Angle Radar Setup)") were updated to headings that exist in the new page ("→ Troubleshooting", "(K-LD7 Device Names)"). Changelog entry added under Unreleased / Fixed.Intentionally left alone: one warning string in
src/openflight/kld7/radc.pythat namesdocs/kld7-troubleshooting.md. Fixing it would make this asrc/change; it can ride along with the next K-LD7 code PR.Why was this required?
The docs restructure (45d3b4d) moved these guides into sectioned directories but did not update the places outside
docs/that point at them. The hardware-help issue template's three "check these first" links have returned 404 since, andsetup.sh, the script README tells every new builder to run, prints "see docs/raspberry-pi-setup.md" in its failure and skip messages, sending users to a file that isn't there.Automated tests
None added. The change is confined to an issue-template YAML, string literals in shell and Python scripts under
scripts/, Markdown link text, and the changelog. No code undersrc/openflight/orui/src/is touched, so there is no behavior to test. Suggest theno-tests-neededlabel.Manual (human) testing
git log --followthat all six old files were deleted in the restructure commit 45d3b4d, and confirmed each successor page by reading its heading (e.g.docs/legacy/troubleshooting.mdis titled "K-LD7 Troubleshooting Guide",docs/development/spin-replay.mdis the reference forreplay_spin_dechirp.py).blob/mainURLs return 404, all three new ones return 200.docs/setup/raspberry-pi.md.docs/….mdpath mentioned underscripts/,.github/, README, CONTRIBUTING, CLAUDE.md, AGENTS.md andui/README.mdagainst the filesystem: zero missing targets remain.bash -non both shell scripts,py_compileon all three Python scripts, andyaml.safe_loadon the template all succeed.uv run pytest tests/test_geekworm_setup.py tests/test_desktop_launcher.py tests/test_openflight_service.py tests/test_project_metadata.py: 21 passed.No UI changes, so no screenshots.
Checklist
uv run pytest tests/ -v) — no Python package code changeduv run pylint src/openflight/ --fail-under=9) — nosrc/changesuv run ruff check src/openflight/) — nosrc/changescd ui && npm run build) — no UI changescd ui && npm run lint) — no UI changes