[documentation] Enhance and fix hw/ip/README.md
Open
@matutem is already working on this.
Since Jan 5, 2024.
Component:Doc
Earlgrey-PROD Triaged
Priority:P2
Type:Cleanup
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Description
The hw/ip/README.md file is generated by the util/gen_doc_hw_summary_table.py, and lists all ips under hw/ip. However, the ips under hw/ip_templates are not listed.
Perhaps the top-specific ipgen ips should be listed under hw//ip_autogen/README.md.
The question is how we present this information, meaning what holds links to these tables, since they are incomplete.
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.