Repository navigation
Add the site, with a protocol reference made from the headers - #10
Merged
Merged
Conversation
firmware/tools/protocol_ref.py writes docs/protocol-reference.md from protocol.h, line_proto.h and wb_proto.h: every request, constant and enum, and each wire struct's fields with their offsets and sizes (checked against the headers' _Static_asserts). The firmware workflow and the new Pages workflow fail if the page is out of date. The site is docs/, the README, the specs and the firmware, hardware, enclosure and net list pages (extra.site_include), on brand's theme. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01B82eRSqjp9Pn2KBr9N9LAn
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.
The hardware's site, https://d-modem.github.io/hardware/, on brand's shared theme and workflow (brand's
docs/sites.md).firmware/tools/protocol_ref.pywritesdocs/protocol-reference.mdfromprotocol.h,line_proto.handwb_proto.h. The page lists every request, constant and enum, plus each wire struct's fields with their offsets and sizes. Those sizes are checked against the headers'_Static_asserts.--checkstep, and the new Pages workflow runs the same check, so the page can't drift from the headers.mkdocs.ymlbuilds a site fromdocs/and the README, plus the specs and the firmware, hardware, enclosure and net list pages. The extra pages come in through brand's newextra.site_include. Board renders load from GitHub.docs/README.mdandfirmware/PROTOCOL.mdlink the new page.Checked locally:
zensical build --strictreports no issues, andcheck_docs.pypasses.Generated by Claude Code