Transition documentation to commonmark
Nobody has claimed this yet.
- Dominant language
- SystemVerilog
- Stars
- 2.1k
- Forks
- 810
- Avg merge
- 5d 23h
- Merged PRs (30d)
- 9
Description
There has been talk about transitioning the ibex documentation into a similar format to that used in OpenTitan (OT) . The motivation is that, once vendored into the OT repository, the ibex documentation could be included in the larger OT documentation.
The format used in OT endeavors to be standard commonmark with only the GitHub Tables, so should work with a number of different site generators. However, it would make sense for ibex to use the same generator as OT (mdbook) for it's own stand-alone documentation generation.
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 by inventorying the Ibex documentation and comparing its current format with OpenTitan's CommonMark and GitHub Tables conventions. Review the mdBook documentation for standalone generation. Done means Ibex documentation can be vendored into OpenTitan and generated independently with mdBook.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100