← Back to team overview

kicad-doc-devs team mailing list archive

Re: 6.0 documentation start

 

Yes that could make sense!

On Sat, Sep 26, 2020 at 3:42 PM N H Designs <nh_designs@xxxxxxxxx> wrote:

> Hi Jon,
>
>
>
> Can I add to the section titles?
>
>
>
> 1) Getting Started
>
> 2) Creating Schematics
>
> 3) Creating PCBs
>
> 4) Outputs for testing and manufacture
>
> 5) Creating and Managing Libraries
>
> 6) Configuring and Customizing KiCad
>
>
>
>
>
> Best Regards
>
> Neil
>
> *NH Designs*
>
>
>
>
>
> *From: *Jon Evans <jon@xxxxxxxxxxxxx>
> *Sent: *26 September 2020 22:25
> *To: *kicad-doc-devs@xxxxxxxxxxxxxxxxxxx
> *Subject: *[Kicad-doc-devs] 6.0 documentation start
>
>
>
> Hi docs team,
>
>
>
> 6.0 Feature Freeze is around the corner.  Once that hits, I plan on
> investing some time in updating the docs, especially for features I've been
> involved with developing.
>
>
>
> Are there any big architectural changes to the docs coming that I should
> wait for before starting this effort?  For example, I'm not sure if we're
> going to try to switch to Asciidoctor, etc.
>
>
>
> One architectural thing I wanted to ask is:
>
>
>
> Currently we have "single page per application" documentation, plus the
> "getting started" page.
>
> While one page per application works well for all the "accessories" like
> GerbView, PCB Calculator, etc, I think it's not the right paradigm anymore
> for the core of KiCad.
>
>
>
> What I would suggest is to instead split up the documentation by "task
> areas":
>
>
>
> 1) Getting Started
>
> 2) Creating Schematics
>
> 3) Creating PCBs
>
> 4) Creating and Managing Libraries
>
> 5) Configuring and Customizing KiCad
>
>
>
> Any thoughts about something like this?
>
>
>
> -Jon
>
>
>

References