lowRISC / lowRISC/opentitan

[doc,site] Add succinct 'human-name' field to all .hjson

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

Description

### Description

In the initial [earlgrey-diagram](https://opentitan.org/documentation/index.html) PR (https://github.com/lowRISC/opentitan/pull/17405#discussion_r1132433916), it was noted that the diagram tooltips use custom names for each block, and it would be nice to pull this data from a single source of truth. The block level .hjson field 'human-name' would be ideal, but some blocks are currently missing this label, and some have labels which are too long to easily integrate into a tooltip.

Contributor guide

Open the contributing guide

Research direction

Review the block-level .hjson files used by earlgrey-diagram, beginning with the initial earlgrey-diagram PR and its discussion. Ensure every block has a succinct human-name suitable for diagram tooltips; the work is done when all relevant .hjson files contain usable labels.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.