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

[bugzilla-daemon at libre-soc.org]

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

Luke Kenneth Casson Leighton <lkcl at lkcl.net> changed:

           What    |Removed                     |Added
----------------------------------------------------------------------------
             Status|CONFIRMED                   |RESOLVED
         Resolution|---                         |WONTFIX

--- Comment #1 from Luke Kenneth Casson Leighton <lkcl at lkcl.net> ---
(In reply to Yehowshua from comment #0)
> 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

this is because they are hosted on github.

> 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.

salsa is not under our control.

> 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.

we do not have time to discuss this right now.

the priority is to complete the tasks for the hard deadline.

closing this bugreport to indicate that we need to seriously prioritise
and not discuss extraneous non-critical tasks.

it can be re-opened when we have time.

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