Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
The docs need better structuring #103
The legacy documentation was set up as 6 manuals. (Paper/PDF)
With the Jekyll site we should change towards a situation where:
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?
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.