[soc_proxy, doc] Improve documentation of soc_proxy
Open
Nobody has claimed this yet.
Component:Darjeeling
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
The soc_proxy is getting merged to master via https://github.com/lowRISC/opentitan/pull/24442. One review comment from @rsahita is to add an image for soc_proxy to the documentation. In general, the documentation for that IP should be improved.
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
The issue points to the soc_proxy documentation and review comment in PR 24442; start there to identify the current documentation and required image. Done means the image is added and the IP documentation is improved, but the issue does not define the broader documentation scope.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation, embedded-iot
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100