lowRISC / lowRISC/opentitan

[doc] Render MUBI registers and reset values correctly

Open
#18,157 0 comments 0 reactions 0 assignees View on GitHub
Component:Doc Earlgrey-PROD Triaged Tool:reggen
Dominant language
SystemVerilog
Stars
3.6k
Forks
1.1k
Avg merge
2d 22h
Merged PRs (30d)
141

Description

### Description

CSRs that are declared as a MUBI in Hjson are not declared as such in the rendered HTML table.
This makes it somewhat difficult to figure out what the reset values mean without looking at the Hjson source.
Example: various page attributes in the flash controller:
https://opentitan.org/book/hw/ip/flash_ctrl/data/flash_ctrl.html#mp_region_cfg

It would be good to address that in the future to improve the documentation experience.

CC @HU90m @jdonjdon

Contributor guide

Open the contributing guide

Research direction

Start with the rendered flash controller page at the linked mp_region_cfg entry and compare its CSR table with the Hjson source. Identify the documentation-rendering entry point and any related tests; done means MUBI declarations and reset values are represented clearly in the generated HTML.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.