Add hardware & SoC architecture reference page - #4
Merged
Conversation
added 2 commits
July 11, 2026 16:18
Users had no way to see what's on the other end of mrg run: the board, the fixed LiteX SoC every node boots, or how much of the FPGA is left for their own design. Adds docs/reference/hardware.md with the address space, a Mermaid architecture diagram, and a real (measured, not estimated) resource budget from building the base SoC. Also wires up Mermaid rendering for the custom theme (superfences already emitted mermaid fences, but nothing rendered them), themed to match docs.css's palette.
The deploy step already guarded itself with if: github.event_name != 'pull_request', but nothing ever triggered the workflow on a PR, so mkdocs build --strict never actually ran as a check before merge. Add the missing trigger.
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
1 participant
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
docs/reference/hardware.md: the board (Lattice ECP5), the fixed LiteX SoC every node boots, the 2 KB user address window, and a real (measured, not estimated) FPGA resource budget built from the base SoC with a no-op placeholder in the user slot.docs/javascripts/mermaid-init.js, loaded as an ES module), themed to matchdocs.css's dark palette, and used for a system architecture diagram on the new page.reference/index.mdandexamples/ffn-accel.md.Test plan
mkdocs build --strictpasses with no warnings/errorsrun()chokes on the<code>child thatpymdownx.superfenceswraps fenced content in🤖 Generated with Claude Code