Contributing to the RISC-V documentation
Welcome to the RISC-V documentation guidelines. This document is maintained by the RISC-V Doc Sig.
This group gathers and works issues from the Doc-sig GitHub repository.
RISC-V documentation contributors:
-
Improve existing content
-
Create new content
-
Ensure content follows the style guidelines
-
Translate the documentation (coming soon!)
How to join RISC-V documentation
-
Create a Linux foundation ID with LFX.
-
Become a member of the RISC-V International organization.
Getting help
If you have questions about authoring, the build toolchain, or the Antora documentation site, the following resources are available:
- sig-documentation mailing list
-
The primary venue for discussion about RISC-V documentation tooling, processes, and the Antora site. Post here for questions about the build infrastructure, the dev playbook, or contributing a new specification.
- help@riscv.org
-
General RISC-V support address for questions that don’t fit the mailing list.
- docs-dev-guide GitHub issues
-
File an issue here if you find something incorrect or missing in this guide.
- antora-dev.riscv.org GitHub issues
-
File an issue here for problems with the RISC-V Antora documentation site or the dev playbook.