machinekit / machinekit-docs

Machinekit website
http://www.machinekit.io
16 stars 52 forks source link

Site needs a replacement #327

Open cerna opened 2 years ago

cerna commented 2 years ago

Due to the move from monorepo machinekit/machinekit to separate repositories like machinekit/machinekit-hal, machinekit/EMCApplication, machinekit/mksocfpga (et cetera) most of the existing documentation in this repository is no longer current or even usable. This is causing problems for potential new users of the suite, because there is no other viable option for them to get at least basic familiarity other then reading the code or asking for help. (For example the machinekit/machinekit-hal#363 issue.)

The site structure itself is problematic and finding even documentation pages one knows exist is herculean effort. (My personal opinion and as stated to me during private conversations.) It's too deeply nested, the structure and logic is a relic from LinuxCNC days and the current theme has readability issues for such long documents.

Also, the build process depends on a Docker container with Jekyll and few additional packages from Michael Haberler based on Debian Jessie which is now _EOL_ed.

From this reason I propose creation of completely new site. Disregarding the current one. (Or maybe keeping it online at some secondary location with clearly stated note about the new one.)

The new site should have the following parts:

Technical proposition how to get it done quickly

(This is how I would have done it. If somebody who actually enjoys webdesign volunteers, then of course he will have the decision to make.)