I agree that if the same documentation is taken as a snapshot of the latest version at that time, it must be clearly noted for the user (and maybe together with a note it is likely out of date compared to the online version).
I will read the README files and we can go from there. Haven't really used gitlab that much and I'm not quite a software engineer but will give it a go. Regards, Tomas On Wed, 19 Jan 2022 at 14:10, Jon Evans <j...@craftyjon.com> wrote: > The documentation lives in this git repo: > https://gitlab.com/kicad/services/kicad-doc > > The same sources build the version on the website (docs.kicad.org) and > the offline docs. > > If keeping the offline docs is important, I think the next best thing is > to insert some extra text in the offline build that gives a warning that > offline docs are likely to be outdated and links to the website. > > -Jon > > On Wed, Jan 19, 2022 at 8:28 AM Tom A. <ta8...@gmail.com> wrote: > >> In my opinion it is great to have fall-back plan such as built in >> documentation (which is particularly handy if you lost internet connection) >> but at the moment it is too different from online version which is why I >> raised this question. >> >> Assuming there is a reasonably easy way to export online docs into >> something that can be bundled together with the software I see no harm in >> continuing with both methods of reaching documentation. Obviously my >> personal opinion. >> >> Where is the current online documentation stored, how to access/modify it >> and how revisions are handled? Is there lifecycle process involved >> (draft-under review-approved/released) or pretty much write it and ask >> someone to look over it? >> >> >> Regards, >> Tomas >> >> >> On Wed, 19 Jan 2022, 08:27 Marco Ciampa, <ciam...@posteo.net> wrote: >> >>> On Wed, Jan 19, 2022 at 08:02:51AM +0000, Martijn Kuipers wrote: >>> > If separate, you could update it more frequently. Just take care it is >>> > understandable for which lkicad version it applies. >>> > >>> > Local docs is where I look first. >>> >>> Version matching should be handled by the packaging system in use, deb / >>> rpm / etc. ... btw keeping docs as a separate package is a good idea and >>> I think it is already so for most of the linux distributions... >>> >>> -- >>> >>> Saluton, >>> Marco Ciampa >>> >>> _______________________________________________ >>> Mailing list: https://launchpad.net/~kicad-developers >>> Post to : kicad-developers@lists.launchpad.net >>> Unsubscribe : https://launchpad.net/~kicad-developers >>> More help : https://help.launchpad.net/ListHelp >>> >> _______________________________________________ >> Mailing list: https://launchpad.net/~kicad-developers >> Post to : kicad-developers@lists.launchpad.net >> Unsubscribe : https://launchpad.net/~kicad-developers >> More help : https://help.launchpad.net/ListHelp >> >
_______________________________________________ Mailing list: https://launchpad.net/~kicad-developers Post to : kicad-developers@lists.launchpad.net Unsubscribe : https://launchpad.net/~kicad-developers More help : https://help.launchpad.net/ListHelp
