kicad-developers team mailing list archive

[Marco Ciampa <ciampix@xxxxxxxxx>]

On Mon, Feb 09, 2015 at 09:35:34AM -0500, Wayne Stambaugh wrote:
> On 2/9/2015 6:43 AM, Nick Østergaard wrote:
> > 2015-02-09 12:01 GMT+01:00 Marco Ciampa <ciampix@xxxxxxxxx>:
> >> That would be nice. Html output is the perfect format for the web, and it
> >> could easily be cross platform since it does not need any of the all
> >> other tools (docbook/latex/etc.) that complicate the toolchain.
> > 
> > Yes, I intend to make the CI do that. I am not sure where if the files
> > should be hosted (chached) somewhere out of the Jenkins workspace. I
> > was thinking pushing them to http://downloads.kicad-pcb.org/, but I
> > will wait fixing that untill we have cmake for the docs. Thank you.
> 
> HTML docs should be pushed to the "Documentation" page on kicad-pcb.org.
>  PDFs will be required for KiCad binary packages.  One thing to consider
> is versioning.  As KiCad gains new features, the documentation will get
> updated accordingly.  However, pushing the latest docs to kicad-pcb.org
> may confuse stable release users who do not yet have these features.
> It's not a major issue right now but it's something we should be
> thinking about.

Other software projects use the main version number to distiguish main
feature version, so the documentation should follow those numbers.

For example GIMP v2.4 had a GIMP manual v2.4, 2.6->2.6, 2.8->2.8 and so
on...

In this way, doc versioning is easier...

--


Marco Ciampa

I know a joke about UDP, but you might not get it.

+------------------------+
| GNU/Linux User  #78271 |
| FSFE fellow       #364 |
+------------------------+