[doc] Signals between blocks can be very hard to read
Open
Nobody has claimed this yet.
Component:Doc
Earlgrey-PROD Triaged
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Description
See for example the OTBN block:
Zooming ten times or more may be required to be able to read the signal name of the edges of the OTBN IP.
Tested on Safari 16.4 (18615.1.26.110.1) & Brave v1.50.121 Chromium: 112.0.5615.138
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked OTBN block theory-of-operations page and inspect how the signal names between blocks are rendered. Check the issue’s Safari and Brave examples first. Done means the signal labels are readable without requiring extreme zoom, with the result verified in the affected diagram.
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
- Needs clarification
- Newbie friendliness
- 25/100