Skip to content

Improve v7.1.2 docs to reduce conflicts with PR #7#8

Open
sensei-hacker wants to merge 12 commits intomasterfrom
update-v7-docs-reduce-conflicts
Open

Improve v7.1.2 docs to reduce conflicts with PR #7#8
sensei-hacker wants to merge 12 commits intomasterfrom
update-v7-docs-reduce-conflicts

Conversation

@sensei-hacker
Copy link
Copy Markdown
Member

@sensei-hacker sensei-hacker commented Mar 25, 2026

Summary

This PR regenerates the INAV v7.1.2 versioned docs with an improved conversion tool, specifically to reduce the number of conflicts with the manually-converted docs in (#7).

If this is merged first, there should be fewer merge conflicts.

Changes from the previous generated docs

  • Fix editUrl branch: tree/maintree/master (this repo uses master)
  • Anchor case normalization: #Nav-Poshold#nav-poshold (Docusaurus anchors are lowercase)
  • Double-hyphen collapsing: GPS--and-CompassGPS-and-Compass in relative links
  • Asset path rewriting: Wiki assets/ and images/ paths rewritten to /img/content/
  • Title case normalization: All-caps front matter titles converted (e.g. TROUBLESHOOTINGTroubleshooting)
  • Special-char filename links: Relative links to pages with colons/commas in filenames now resolve correctly via normalized page-mapping lookup
  • Paren sanitization in filenames: Lightweight-Telemetry-(LTM).mdLightweight-Telemetry-LTM.md (parens in filenames break markdown link syntax)
  • Second link-rewrite pass: Uses the versioned output directory as the mapping source to fix any remaining cross-category link discrepancies
  • File moves: GPS-and-Compass-setup moved to quickstart/ (matches category mapping); Navigation-Mode:-Return-to-Home moved to features/
  • Combined release notes: Separate 7.0.0-Release-Notes.md and 7.1.0-Release-Notes.md merged into a single tabbed Release-Notes.md

Remaining known broken links (11 total)

These are unavoidable without a rename map — the wiki renamed pages between versions:

  • Sensor-calibration.md → wiki renamed to Calibration-Tab.md (9 links)
  • New-features-over-versions-log.md → wiki renamed to Older-Release-Notes.md (2 links)

These produce onBrokenLinks: "warn" warnings, not build errors.

Test plan

Improved tool output to reduce conflicts with the manually-converted
docs in #7:

- Fix editUrl branch: tree/main → tree/master (repo uses master)
- Normalize anchor fragments to lowercase (e.g. #Nav-Poshold → #nav-poshold)
- Collapse double hyphens in relative link paths (GPS--and → GPS-and)
- Rewrite wiki assets/ and images/ paths to /img/content/
- Normalize all-caps front matter titles to title case (TROUBLESHOOTING →
  Troubleshooting)
- Fix relative .md links whose filenames have special chars (colons, commas)
  via normalized page-mapping lookup
- Sanitize parentheses from output filenames: Lightweight-Telemetry-(LTM)
  → Lightweight-Telemetry-LTM (parens break markdown link syntax)
- Run a second link-rewrite pass using versioned output as the mapping
  source to fix any remaining cross-category links
- Move GPS-and-Compass-setup to quickstart/ (matches category mapping)
- Combine individual release note files into a single tabbed Release-Notes.md
  (drops 7.0.0-Release-Notes.md and 7.1.0-Release-Notes.md)
@sensei-hacker sensei-hacker requested a review from robotgoat March 25, 2026 02:19
Fixes [INAV Wiki](https://github.com/.../wiki/Lightweight-Telemetry-(LTM))
being rewritten to ...LTM.md)) with an extra closing paren.

The URL capture regex now allows one level of balanced parens so the
outer markdown link-close ) is correctly identified.
Rebuilt from updated wiki commit that includes:
- Sensor-calibration → Calibration-Tab link fixes
- servo-autotrim → servo-autotrim-fw anchor fixes
- autotune → autotune-fw anchor fixes
- setting-up-failsafe-with-return-to-home → setting-up-failsafe-for-rth
- New-features-over-versions-log → Older-Release-Notes
- MSP arming blocker URL /_edit suffix removed
- Skyhunter heading simplified (version qualifier removed)
@sensei-hacker
Copy link
Copy Markdown
Member Author

This is basically the same as #7 , with the merge conflicts fixed.
Also the links are a little more consistent in this version.

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