WaveDrom documentation fix + other doc updates#461
Merged
AlexJones0 merged 5 commits intolowRISC:mainfrom Apr 14, 2026
Merged
Conversation
Fix execution environment for the WaveDrom mdbook preprocessor by explicitly providing Python 3 as a native build input and invoking the preprocessor via the mdBook command configuration, avoiding reliance on the `/usr/bin/env` shebang resolution that seemed to not be working with Nix. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
Ensure that WaveDrom DOM manipulation runs after mdBook mutations complete by switching from window load to `DomContentLoaded`. Should hopefully prevent partial DOM rewriting which is the likely cause of the issues in rendering. Issues likely appeared at a certain point as a newer version of mdBook was pulled in that has some different DOM mutation behaviour. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
Make sure that the linked documentation actually reflects the state of the registers, even if it isn't on the rendered OpenTitan site. Also make a couple of grammatical fixes and correct a typo. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
These were out of date for the newer releases which combined multiple interrupt sources into a single shared interrupt line per block/instance, and which also added more interrupt sources (GPIO, USB device, hardware revoker). Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
AlexJones0
requested review from
elliotb-lowrisc,
engdoreis and
marnovandermaas
elliotb-lowrisc
approved these changes
Apr 13, 2026
SPI interrupts have been implemented in HW for a while, these docs are just out of date. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
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
2 participants
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.
Closes #423.
Closes #199.
Closes #146.
Mostly focused around fixing the existing WaveDrom issue. Also solves a couple of outstanding issues where linked documentation is not pinned to the correct revision, causing it to become out of date as the relevant vendored blocks are changed upstream. Maybe it would be better to just include the old OT docs in-place (like we do for SPI Host) now that WaveDrom is fixed, but for now this keeps the changes simple. Finally, updates the PLIC documentation since this was entirely out of date at this point.
Tested locally using: