machinekit-docs icon indicating copy to clipboard operation
machinekit-docs copied to clipboard

The docs need better structuring

Open luminize opened this issue 9 years ago • 1 comments
trafficstars

The legacy documentation was set up as 6 manuals. (Paper/PDF)

With the Jekyll site we should change towards a situation where: Buildup from explanations of What machinekit is and does, towards getting started (terminal), making configurations, examples, increasing the level of knowledge towards the more "developers" and api stuff.

I've got no idea if this is technically do-able, but how about explaining all parts in correct order, and showing/hiding/collapsing (button, checkmark in the site) some more advanced stuff for those who need it?

luminize avatar May 29 '16 08:05 luminize

It would certainly help to have configs in the docs.

One of the most common Q's is about setting up a machine, for which there is already a sample config, but the questioner does not know that or where to find it.

The linuxcnc documents always confused me as to which manual I needed to look in, user, integrator etc.

It might be one to throw open to the floor, it is the people who don't know stuff, who know what they need but cannot find.

ArcEye avatar May 29 '16 08:05 ArcEye