Create an HTML version of the ISA specs (and non-ISA)

riscv-admin / docs-sig

The repository of the RISC-V Docs Team

https://jira.riscv.org/browse/RVG-36

Creative Commons Attribution 4.0 International

1 stars 0 forks source link

Open kersten1 opened 6 months ago

kersten1 commented 6 months ago

An important goal this year is to create an HTML version of the ISA specs in a consumable framework. Consider developer.arm.com as an example

[ ] Produce a polished web representation of the RISC-V specifications and supporting documentation.
[ ] Utilize a software tool such as Antora to present Git repos on the web
[ ] Ensure that the HTML and PDF templates are consistent and conform with the RISC-Branding Guidelines for fonts and colors (https://riscv.org/about/risc-v-branding-guidelines/)

kbroch-rivosinc commented 4 months ago

I like to discuss adding this functionality to the doc-spec-template for the following reason:

give authors/reviewer another format in which to read the docs
- using GitHub pages to host could provide search, better nav, etc
allow doc-sig team to start seeing how the HTML output looks
get familiar with Antora

I'm going to prototype this in the doc-sig repo

wmat commented 4 months ago

For the record, many specs already build HTML versions. For example, the riscv-isa-manual does.

However, that's not exactly the same as setting up an Antora based documentation site.