Open
Conversation
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 https://gist.github.com/sensei-hacker/cc2fecec1c88bb201e5a4bb0010baa80 Key things the diff shows:
|
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.
50a6ecb to
dee3843
Compare
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")
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.
Summary
versioned_docs/version-7.1.2/versioned_sidebars/version-7.1.2-sidebars.json"7.1.2"toversions.jsononBrokenLinksfrom"throw"to"warn"indocusaurus.config.tsHow 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:
> [!NOTE]→:::note)Air<2g→Air\<2g)<br>→<br />,class=→className=)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 buildcompletes successfully (warnings only, no errors)versioned_docs/version-7.1.2/