Rewrite installation guide and docs in general - Githubissues

k4kfh / ZephyrCab

Drive a model train with prototypical controls, realistic behavior, and simulated physics; uses JMRI's WebSockets interface for layout connection

http://k4kfh.github.io/ZephyrCab

GNU Affero General Public License v3.0

10 stars 4 forks source link

Rewrite installation guide and docs in general #20

Open k4kfh opened 7 years ago

k4kfh commented 7 years ago

The docs, particularly the installation guide and other new-user material, are horribly outdated and just generally a fragmented mess. Need to fix ASAP; maybe move to mkDocs Material theme for some consistency across projects.

Docs Rewrite:

[x] Switch to Material theme
[x] Include download link
[x] Rewrite installation guide for new users
[x] Rewrite general configuration guide for new users
- Talk about cfg file
- Talk about bundles.json
[ ] Update developer standards pages

k4kfh commented 7 years ago

Follow this template for the installation guide, and write one for Debian-based Linux and potentially Windows+OSX.

k4kfh commented 7 years ago

I made several improvements on the docs over the last few days. I've changed the site over to the mkdocs-material theme, and I've created several pages of basic "getting started" kind of material. I also added a "Supported Locomotives and Decoders" page for reference, with ratings for the stability of the different things.

k4kfh commented 7 years ago

I just created a few "deprecated" messages on the Wiki that's built in to the GitHub repo. I did not remove the old pages, but I did remove the links to them on the sidebar and on the main page, and I added a giant header to let users know those docs have been moved.

k4kfh commented 7 years ago

Need to rewrite the installation guide to show how to install within JMRI.