search

openhwgroup / cva6

The CORE-V CVA6 is an Application class 6-stage RISC-V CPU capable of booting Linux
https://docs.openhwgroup.org/projects/cva6-user-manual/
Other
2.23k stars 679 forks source link

[TASK] generate documentation (User Manual and Design Documentation) with templating #1691

Open JeanRochCoulon opened 10 months ago

JeanRochCoulon commented 10 months ago

Is there an existing CVA6 task for this?

Task Description

Several cva6 configurations must co-exit in documentations Templating will allow to maintain one single master document and generate all the configuration documents

Required Changes

Create a master document with templating. All configurations will be specified in it. Then different configuration document will be generated from it.

Current Status

All configurations are described in User Manual. Design document describes only one configuration: the embedded configuration.

Risks

Warning: the templating should be easy to maintain to allow everybody to write specifications. Have the technical solution reviewed within CVA6 project before deploying on documentation.

Prerequisites

none

KPI (KEY Performance Indicators)

none

Description of Done

Commit of User Manual and Design Document master doc

Associated PRs

No response

JeanRochCoulon commented 10 months ago

@jquevremont

jquevremont commented 10 months ago

Hi @JeanRochCoulon, I have completed the description so that the solution is reviewed before deployment.

jquevremont commented 9 months ago

Status on 2023-12-23: User manual updated to ease templating, except PMP.rst and Traps_Interrupts_Exceptions.rst, for which we need the contributions of the specialists of the CV32A60X embedded configuration.