[libre-riscv-dev] [Bug 300] New: Documentation for the SOC

[bugzilla-daemon at libre-soc.org]

https://bugs.libre-soc.org/show_bug.cgi?id=300

            Bug ID: 300
           Summary: Documentation for the SOC
           Product: Libre-SOC's first SoC
           Version: unspecified
          Hardware: PC
                OS: Mac OS
            Status: CONFIRMED
          Severity: minor
          Priority: ---
         Component: Source Code
          Assignee: lkcl at lkcl.net
          Reporter: yimmanuel3 at gatech.edu
                CC: libre-riscv-dev at lists.libre-riscv.org
   NLnet milestone: ---

The SOC would benefit from good documentation.
The wiki is likely not the appropriate place to host documentation.

It seems a number of open source projects host documentation on a static site
which build from a ./docs folder in the git repository.

https://github.com/YosysHQ/nextpnr/tree/master/docs 
https://github.com/SymbiFlow/prjtrellis/tree/master/docs 
https://github.com/enjoy-digital/litex/tree/master/doc

LibreSOC would benefit from following this convention.
To accomplish this, a gitlab ci.yaml can be placed in the ./docs directory of
soc.git. This way,  it is at least possible to view documentation at
Kazan-team.salsa.debian.io/docs. The documentation's bootstrap can also be
modified to match libreSOC’s main site.

It is probably fine to link to salsa from the wiki for now. We can always bring
the static site directly onto libreSOC’s servers later.

-- 
You are receiving this mail because:
You are on the CC list for the bug.