Rewrite installation guide and docs in general
k4kfh opened this issue · 4 comments
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:
- Switch to Material theme
- Include download link
- Rewrite installation guide for new users
- Rewrite general configuration guide for new users
- Talk about
cfgfile - Talk about
bundles.json
- Talk about
- Update developer standards pages
Follow this template for the installation guide, and write one for Debian-based Linux and potentially Windows+OSX.
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.
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.
Need to rewrite the installation guide to show how to install within JMRI.