Skip to content

docs: fix callouts, wiki references, and improve hardware pages#7204

Merged
pfeerick merged 13 commits into
mainfrom
pfeerick/docs-wiki-update
Mar 23, 2026
Merged

docs: fix callouts, wiki references, and improve hardware pages#7204
pfeerick merged 13 commits into
mainfrom
pfeerick/docs-wiki-update

Conversation

@pfeerick
Copy link
Copy Markdown
Member

@pfeerick pfeerick commented Mar 23, 2026

Summary

  • Convert GitHub-style callouts to MkDocs Material admonition format, and replace "wiki" self-references with "documentation"
  • Improve hardware pages: expand radio-specs.md stub and hide TOC sidebar on wide-table pages
  • Restructure "Building EdgeTX" navigation: reorganise sections, move WSL guide under Windows, add Troubleshooting section with unbrick guide
  • Update CLI commands reference with missing entries
  • Rewrite compilation-options.md with categorised tables, full PCB/PCBREV target lists, and valid values for all string options
  • Add docs/README.md covering local MkDocs setup and contribution guidance, and update repo README to link to the developer documentation site

🤖 Generated with Claude Code

- Convert GitHub-style callouts (> [!NOTE], > [!TIP]) to MkDocs
  Material admonition format in codespaces.md and macos-sequoia.md
- Replace "wiki" self-references in index.md with "documentation"
- Fix garbled sentence in linux-wsl.md Compiling section
- Expand radio-specs.md stub into a proper page describing the
  externally-maintained spec table
- Hide right sidebar (TOC) on wide-table hardware reference pages:
  dma-mapping-tx16s.md, dma-mapping-nv14.md, irq-usage-tx16s.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@pfeerick pfeerick added the documentation 📝 Improvements or additions to documentation label Mar 23, 2026
pfeerick and others added 12 commits March 23, 2026 04:57
…ugh args

Add trigger_watchdog_reset, testfatfs, spacemouse, and reset_gt911 commands.
Fix serialpassthrough parameters to show port number and baudrate as optional.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…x.md

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
…B/PCBREV values

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
non-anchored .cache used for clangd .cache/clangd/ index directory is enough to catch mkdocs cache directory also.
@pfeerick pfeerick merged commit 6ce88fc into main Mar 23, 2026
1 check passed
@pfeerick pfeerick deleted the pfeerick/docs-wiki-update branch March 23, 2026 23:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation 📝 Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant