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.
(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.
deferred till after oct tapeout
(In reply to Jacob Lifshay from comment #2) > deferred till after oct tapeout Just noticed this when searching for the Power9 TRAP Pipeline bug report. I want to leave a note for the deferred discussion. I think that I should work with Yehowshua on the documentation, when the time is right, because I have the unique (for now, hopefully we will have more noobs join) perspective of understanding very little prior to interacting with the project, so I think I'll be able to help make the documentation more novice friendly.