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

Create a glossary for RISC-V #1

Open kersten1 opened 6 months ago

kersten1 commented 6 months ago

There is a glossary topic here - https://github.com/riscv/riscv-glossary.

This topic needs to be spruced up and then can be distributed as part of the HTML, unless we decide that it is worth of inclusion in the ISA PDFs.

kbroch-rivosinc commented 4 months ago

I can imagine including the whole RISCV glossary in some specs would be overkill but if it was useful, I would submodule the repo in and then include like this: https://docs.asciidoctor.org/asciidoc/latest/sections/glossary/#glossary-section-syntax

There's also the possibility of using tags in the glossary items to allow partial inclusion https://docs.asciidoctor.org/asciidoc/latest/directives/include/#include-syntax

Finally many glossary items are acronyms, I am going to explore creating #31. With something like this we could get interesting functionality like:

kersten1 commented 4 months ago

First part of this is complete - the glossary exists - https://github.com/riscv/riscv-glossary/