[doc,mbx] Complete mailbox documentation
Open
@alees24 is already working on this.
Since Feb 26, 2025.
Component:Doc
IP:mailbox
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
### Description
The mailbox is missing:
* Brief `README.md` summarising the block.
* "Theory of operation" describing the mailbox's design.
* "Programmer's guide" describing how to configure and use the mailbox from software.
* DV testbench documentation and checklist.
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.
Assessment
This issue has not been assessed yet.