docs(web_apps): list all consoles by category + polish the apps index - #778
Merged
Conversation
web_apps.rst was stale (listed ~6 of 15 apps). Rewrite it grouped by category (device hub & dispatcher-module consoles, motor control, CAN/serial adapters, general) with accurate :doc: cross-references. generate_apps_index.py now sorts cards by display title and shows the app count in the subtitle (flat grid unchanged). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Warning
Copilot couldn't run its full agentic review because it didn't start before the timeout. Make sure your repository has a runner available, or add a copilot-code-review.yml file specifying one with the runs-on attribute. See the docs for more details.
Pull request overview
Updates the web apps documentation and the generated apps gallery index to reflect the current set of hosted consoles and improve discoverability.
Changes:
- Rewrote
doc/en/web_apps.rstto list all web apps grouped by category with updated cross-references. - Updated
doc/generate_apps_index.pyto sort app cards by display title and show an app-count subtitle.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/generate_apps_index.py | Sort gallery cards by extracted <title> and add app count to the subtitle. |
| doc/en/web_apps.rst | Refresh and reorganize the web apps documentation into categories with updated app listings. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+11
to
+12
| Each app is a single HTML file; it also runs offline straight from its | ||
| ``components/<name>/web/`` directory via a ``file://`` URL. |
| def main() -> int: | ||
| apps_dir = Path(sys.argv[1]) | ||
| apps = sorted(p for p in apps_dir.glob("*.html") if p.name != "index.html") | ||
| apps = [p for p in apps_dir.glob("*.html") if p.name != "index.html"] |
Comment on lines
+37
to
+39
| # regardless of file name. | ||
| entries = sorted(((extract(p), p.name) for p in apps), | ||
| key=lambda e: e[0][0].casefold()) |
| ======================================= | ||
|
|
||
| Devices built on the :doc:`dispatcher <dispatcher/dispatcher>` / ``stream_frame`` | ||
| protocol expose one or more *modules* over a single USB vendor (WebUSB) |
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.
Housekeeping for the web apps documentation now that there are 15 of them.
doc/en/web_apps.rstwas stale — it listed ~6 apps and predated the whole dispatcher-module family and the serial CAN/MCP consoles. Rewritten and grouped by category: device hub & dispatcher-module consoles (hub, OTA, core dump, haptics, CAN bridge, DS402, MCP266), motor control (ODrive ASCII/native, WebHID visualizer), CAN & serial adapters (Basicmicro MCP, slcan CAN), and general (Board Console & flasher), with accurate:doc:cross-references.doc/generate_apps_index.py(the auto-generatedapps/index.htmlgallery): cards are now sorted by display title and the subtitle shows the app count. Flat grid unchanged. Verified against the real consoles (14 hosted apps).Follow-up (separate PR): dedupe the shared front-end JS (stream_frame codec,
requestUsbDevice, discovery decoder) into a canonicalespp_web_core.js.🤖 Generated with Claude Code