lowRISC / lowRISC/ibex

Transition documentation to commonmark

Open
#2,010 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Component:Doc
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.