Skip to content

The docs need better structuring #103

Open

Description

@luminize

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?

Activity

  1. ArcEye commented on May 29, 2016

    @ArcEye
    Contributor

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions