New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The docs need better structuring #103

Open
luminize opened this Issue May 29, 2016 · 1 comment

Comments

Projects
None yet
2 participants
@luminize
Copy link
Member

luminize commented May 29, 2016

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?

@ArcEye

This comment has been minimized.

Copy link
Contributor

ArcEye commented May 29, 2016

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment