[top_earlgrey/doc] Update detailed specification for Earl Grey 2
Open
Nobody has claimed this yet.
TOP:earlgrey
- Dominant language
- SystemVerilog
- Stars
- 3.6k
- Forks
- 1.1k
- Avg merge
- 2d 22h
- Merged PRs (30d)
- 141
Description
Once the design has stabilized, we should update the detailed spec for Earl Grey 2 living under `hw/top_earlgrey/doc/design/README.md` and rendered here `https://opentitan.org/book/hw/top_earlgrey/doc/design/index.html`. At the moment, this doc contains information for Earl Grey Gen1.
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
Start with hw/top_earlgrey/doc/design/README.md and compare it with the rendered specification at https://opentitan.org/book/hw/top_earlgrey/doc/design/index.html. Wait for the Earl Grey 2 design to stabilize, then update the detailed specification so it describes Earl Grey 2 rather than Earl Grey Gen1; verify the rendered documentation reflects the changes.
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
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100