kicad-doc-devs team mailing list archive

[Marco Ciampa <ciampix@xxxxxxxxxx>]

On Mon, Sep 28, 2020 at 09:25:57AM +0300, Константин Барановский wrote:
> It would be great if the documentation will be separate to two parts:
> offline and online.
> "Offline" docs describe tools (menu items), settings, warnings and
> restrictions. These docs *have to* be installed with KiCad and be available
> for users at any time.
> "Online" docs may be organized as a wiki. The KiCad Wiki may contain as the
> large articles like "Getting started", "Creating schematic/pcb/library" as
> the small articles like "Tracing diff pairs", "Creating pads with custom
> shapes" etc.
> Articles may be created by developers to describe new features they bring.
> Many themes from the kicad forum have some useful solutions that may be
> converted to the wiki articles.
> I think KiCad must have a wiki.

I understand that wikis are the most "easy to use" documentation
platforms. Unfortunately they are not that mature from a translation
management point of view. I may be wrong but I do not see any
translatable wiki management with capabilities nearly as powerful as we
have now with the combination of asciidoc + po4a.

I use on a daily basis wikipedia's mediawiki, and being one of the most
advanced wikis out there, it's i18n cababilities simply suck. You end up
copying and pasting from the english pages to another language and from
that point you become the author of your translation. The source doc and
the translation become two unrelated entities. Its translation management
so becomes a nightmare.

--

Saluton,
Marco Ciampa