kicad-developers team mailing list archive

[Nick Østergaard <oe.nick@xxxxxxxxx>]

Everything for the docs should be in the github project
https://github.com/kicad/kicad-doc

As far as I know there is no collection of notes on what features needs to
be documented. We may need to get an overview of this before having any
real idea of what is really missing. Anyone with the motivation to get into
this please proceed.

2017-11-01 12:11 GMT+01:00 Kristoffer Ödmark <kristofferodmark90@xxxxxxxxx>:

> How does the documentation work now? Do we have any standardisation on how
> to document?
>
>
> On 11/01/2017 09:53 AM, Maciej Sumiński wrote:
>
>> On 11/01/2017 09:40 AM, Carsten Schoenert wrote:
>>
>>> Hello Wayne,
>>>
>>> Am 31.10.2017 um 13:06 schrieb Wayne Stambaugh:
>>>
>>>> We are very close to a feature freeze and creating a 5 stable branch.
>>>> Once that is done, it typically takes a few months to make sure there
>>>> are no critical or major bugs before we can release.  The goal is to
>>>> have it released before FOSDEM 2018 so I have some good news to deliver
>>>> during the KiCad presentation.
>>>>
>>>
>>> I guess we are all happy to see the incredible and amazing evolving of
>>> KiCad within a new version 5. I'm thankful to all people and companies
>>> who have contributed in the past year!
>>>
>>> As one of the persons which tries to keep the German translations
>>> up2date I'm a bit concerned if this targeted timeline is possible
>>> especially for KiCad documentation!?
>>> Given that most of all the new features are not made it into kicad-doc
>>> yet and the mess that every change in the master PO files brings for the
>>> updates of the specific languages I think it would be at least a big
>>> issue if with releasing of KiCad5 no actual documentation even in en_US
>>> is available. Missing documentation is one of the major annoying things
>>> for users!
>>>
>>> I'm not a native English speaking person so even if I had time (and the
>>> correct knowledge about the new features) I can't help much here. But I
>>> wanted to raise my concerns about this missing thing.
>>>
>>> Is here something planned or someone has started to work in this corner
>>> and/or is there a place this is tracked? There are only about three
>>> months left until FOSDEM.
>>>
>>
>> Hi Carsten,
>>
>> I share your concerns about the documentation. Nevertheless, before we
>> start working on the docs, I think we need to reach the feature freeze
>> stage, otherwise documentation would have to be updated too frequently
>> during the development cycle.
>>
>> We are going to need at least a few more weeks after the feature freeze
>> starts to iron out bugs. During this period the user interface and
>> functionality should not change, so it would be the best time to update
>> the documentation. I suppose we should start updating the manuals early,
>> so the translators have the time to react as well.
>>
>> Regards,
>> Orson
>>
>>
>>
>> _______________________________________________
>> Mailing list: https://launchpad.net/~kicad-developers
>> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
>> Unsubscribe : https://launchpad.net/~kicad-developers
>> More help   : https://help.launchpad.net/ListHelp
>>
>>
> --
>  -Kristoffer
>
>
> _______________________________________________
> Mailing list: https://launchpad.net/~kicad-developers
> Post to     : kicad-developers@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~kicad-developers
> More help   : https://help.launchpad.net/ListHelp
>