Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transition documentation to commonmark #2010

Open
HU90m opened this issue Apr 5, 2023 · 0 comments
Open

Transition documentation to commonmark #2010

HU90m opened this issue Apr 5, 2023 · 0 comments
Labels
Component:Doc Documentation issue

Comments

@HU90m
Copy link
Member

HU90m commented Apr 5, 2023

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.

@HU90m HU90m added the Component:Doc Documentation issue label Apr 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component:Doc Documentation issue
Projects
None yet
Development

No branches or pull requests

1 participant