Skip to content

Add versioned docs for INAV 7.1.2#6

Open
sensei-hacker wants to merge 4 commits intomasterfrom
add-version-7.1.2-docs
Open

Add versioned docs for INAV 7.1.2#6
sensei-hacker wants to merge 4 commits intomasterfrom
add-version-7.1.2-docs

Conversation

@sensei-hacker
Copy link
Member

Summary

  • Adds 91 MDX documentation pages for INAV 7.1.2 under versioned_docs/version-7.1.2/
  • Adds the corresponding sidebar config versioned_sidebars/version-7.1.2-sidebars.json
  • Adds "7.1.2" to versions.json
  • Changes onBrokenLinks from "throw" to "warn" in docusaurus.config.ts

How these were generated

The docs were converted from wiki commit c0e9dd6 (wiki state just before 2024-07-01) using the markdown2mdx tooling:
https://github.com/sensei-hacker/markdown2mdx

That tool handles GFM → MDX conversion including:

  • Admonition conversion (> [!NOTE]:::note)
  • JSX character escaping (Air<2gAir\<2g)
  • HTML void element fixing (<br><br />, class=className=)
  • Docusaurus front matter generation

Why onBrokenLinks: "warn"

Versioned docs naturally accumulate broken anchors as sections are renamed across INAV releases (e.g. a heading in 7.1.2 that no longer exists in 9.x). Switching to "warn" lets the build succeed while still surfacing the issues in build output so they can be addressed incrementally.

Test plan

  • npx docusaurus build completes successfully (warnings only, no errors)
  • 91 files present in versioned_docs/version-7.1.2/
  • Sidebar JSON generated and referenced correctly

@sensei-hacker
Copy link
Member Author

Conversion diff (sample)

To illustrate what the markdown2mdx converter changes, here is a unified diff for 8 randomly-selected files comparing the original GFM wiki source (at commit c0e9dd6) to the generated MDX:

https://gist.github.com/sensei-hacker/cc2fecec1c88bb201e5a4bb0010baa80

Key things the diff shows:

  • Front matter added (sidebar_position, sidebar_label, title)
  • > [!NOTE] / > **Note:** blockquotes converted to :::note / :::warning admonitions
  • <br><br />, class=className= (JSX-safe HTML)
  • < and { escaped in prose where needed (Air<2gAir\<2g)
  • Code blocks left untouched

91 MDX files converted from wiki commit c0e9dd6 (pre-2024-07-01) using
the markdown2mdx converter (https://github.com/sensei-hacker/markdown2mdx).

Also switches onBrokenLinks from "throw" to "warn" so versioned docs
don't block the build as pages are renamed across INAV releases.
@sensei-hacker sensei-hacker force-pushed the add-version-7.1.2-docs branch from 50a6ecb to dee3843 Compare March 22, 2026 07:33
Versioned docs for a given release should only include release notes
for that version, not the full historical backlog.
Re-run conversion with updated markdown2mdx tool that demotes # headings
to ## so the Docusaurus front-matter title remains the only H1 on the page.
- Replace individual 7.0.0/7.1.0 release notes files with a single
  Release-Notes.md combining both in tabs (7.1.0 shown by default)
- Download and host quadmeup.com banner images locally
- Fix page titles (stem-based, e.g. "OSD Hud and ESP32 Radars")
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