fix: repair broken internal links across four patterns - #2
Merged
Conversation
Fixes four distinct classes of broken relative links found in the published (non-scratch) pages under website/md-docs: - Mangled GitBook-artifact placeholder link (../lcd-functions-less-than-greater-than-luadoc-begin-lcd/...) now points at api-reference/display-lcd.md, or api-overview/constants/color-constants.md#indexed-colors where the color table is the actual referent. - Broken appendix references (../appendix/units.html, ../../part_vii_-_appendix/fonts.md) now point at api-overview/constants/units.md and api-overview/fonts.md. Also fixes a stray extra pair of parens around the units.html link in runtime-play-number.md and runtime.d.lua. - Links assuming a topic subfolder under api-reference/ (e.g. api-reference/variables/runtime-get-value.md) flattened to the actual flat layout (api-reference/runtime-get-value.md). - Off-by-one relative path to assets/luals/*.d.lua in programming/basics/editor.md (one ../ too many). review-*.md QA scratch pages and module-*.md dashboards carry duplicate copies of some of these same broken strings but are left as-is: they are excluded from the production build via the mkdocs.yml/mkdocs.dev.yml split (separate change) and are throwaway extraction artifacts, not hand-maintained prose. Verified with `mkdocs build --strict` (exit 0, zero warnings). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015yCHydHbzZYCKpav38SonD
This was referenced Sep 7, 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
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
Fixes the four distinct classes of broken relative links identified during the pre-merge gap analysis against the official EdgeTX Lua reference guide (Finding 2 of that review):
<!-- LUADOC:BEGIN lcd -->-style comment got slugified into a literal, non-existent path (../lcd-functions-less-than-greater-than-luadoc-begin-lcd/lcd_functions-overview.html) across everylcd-draw-*/lcd-get-color/lcd-set-color/etc. page. Now points atapi-reference/display-lcd.md, orapi-overview/constants/color-constants.md#indexed-colorson the two lines where the color table is the actual referent (matching the anchor already used correctly elsewhere, e.g.programming/core-concepts/drawing-flags-and-colors.md).../appendix/units.htmland../../part_vii_-_appendix/fonts.mdpointed at a directory that doesn't exist in this site. Now point atapi-overview/constants/units.mdandapi-overview/fonts.md. Also fixes a stray extra pair of parens around the units.html link inruntime-play-number.mdandruntime.d.lua([Full list]((../appendix/units.html))).api-reference/— several links assumed nesting likeapi-reference/variables/runtime-get-value.mdthat doesn't exist; all detail pages are flat directly underapi-reference/. Flattened.programming/basics/editor.md— linked to../../../assets/luals/*.d.lua(one level too many, landing outsidemd-docs/); corrected to../../assets/luals/*.d.lua.Scope note: the
review-*.mdQA scratch pages andmodule-*.mddashboards carry duplicate copies of some of these same broken strings but are intentionally left untouched — they're throwaway extraction/review artifacts, not hand-maintained prose, and are slated for exclusion from the production build separately (mkdocs.yml/mkdocs.dev.ymlpublic/dev split).Test plan
mkdocs build --strict— exit 0, zero warnings#indexed-colorsanchor matches the slug already used correctly elsewhere in the site for the same sectionwebsite/md-docstree afterward to confirm zero remaining matches for any of the four broken patterns outsidereview-*.md/module-*.md🤖 Generated with Claude Code
https://claude.ai/code/session_015yCHydHbzZYCKpav38SonD