[doc] Document support Ibex configurations
Open
Nobody has claimed this yet.
Component:Doc
Component:Tool-and-Build
Type:Task
- Dominant language
- SystemVerilog
- Stars
- 2.1k
- Forks
- 810
- Avg merge
- 5d 23h
- Merged PRs (30d)
- 9
Description
Document what it means to be an 'supported' configuration along with the current supported configurations and how the ibex_config.py utility works.
Part of the configuration documentation can be autogenerated from the ibex_configs.yaml file. This will require adding a description field to each configuration.
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
Read ibex_config.py and ibex_configs.yaml first to understand how the utility works and how configurations are represented. Document the meaning of a supported configuration, the current supported configurations, and the utility; add description fields to each configuration so the relevant documentation can be autogenerated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python, yaml
- Domain
- documentation, tooling
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100