Skip to content

Release Checklist

Everything on this page supports the team being able to determine when these docs can be released.

This is a list of to do items that will allow us to release this new documentation, and move the existing to a separate "legacy-docs" URL for reference only.

Content

  • Conductor friendly getting started with RTR and officially supported Mega DIY stack only:

    • General getting started page
    • General EX-CommandStation page
    • Clarity on what you need including good and recommended power supplies
    • EXRAIL under EX-CS
    • TrackManager under EX-CS - no waveform/DC PWM details, they can be a reference later, just focus on config and use
    • EX-CSB1 RTR information - must be complete
    • Mega DIY stack page - Mega + EX8874/Arduino R3 + WiFiShield8266 only (no hardware mods, plug n play only)

  • Advanced DIY stacks:

    • ESP32
    • Nucleo

  • Product pages for:

    • CommandStation (includes EXRAIL and TrackManager)
    • EX-CSB1
    • EX-Motorshield8874
    • EX-WiFiShield8266

  • Better how to get help and support info:

    • How to use Discord, code snippets, upload files, raise a ticket
    • What are the logs/file required, how to get them

  • EX-CommandStation troubleshooting steps:

    • USB issues - drivers, cables, ports, permissions, other programs open
    • WiFi/serial interfering
    • WiFi issues
    • EX-Installer common issues
    • Not seeing roster/routes/turnouts in throttles/JMRI

  • I2C more accessible information:

    • As close to "out-of-the-box" as we can get device list (Adafruit, Qwiic, etc.)
    • Wiring/pullups/distance in layman's terms
    • Default device addresses and how to disable
    • Troubleshooting steps

  • Purchasing information for hardware:

    • Official DCC-EX reseller stores
    • Recommended third-party suppliers

  • EXRAIL command reference from doxyGen

  • User journeys to guide users through the site:

    • Brand new users no knowledge
    • Just want to run trains
    • Just want to run trains - DC only version
    • Wanting to add accessories
    • Wanting to animate/automate
    • Large club layout
    • Downloader

  • Add donation info

Release QA Items

  • Proof-reading all pages but not by original author
  • Address all TODO markers search for TODO

Menu and Page Structure

  • All hardware pages should "next" onto the EX-Installer EX-CommandStation configuration instructions, maybe nav plugin extension, maybe JS

  • If DIY on tap nav menu, RTR must be their too, choose:

    • Both DIY and RTR on nav menu
    • Move both under products menu

  • Redirects for key items from the previous site, and QR codes on hardware devices

    • EX-CSB1 QR code
    • EX8874 QR code
    • show QR codes for Toolbox, and ED.
    • and any other recommended throttle apps.

  • Page numbers should be double digits (leading 0)

Styling

  • Revisit navigation menu bar colouring
  • Table separator colours are almost invisible
  • Validate all colours are accessible friendly (reports links might be difficult to read)

Team Info

  • Ensure MkDocs contributor guide covers all customisations

    • How to use our logos
    • Grid cards
    • CSS/JS customisations
    • Custom plugins
    • Custom footer
    • How we use Material extensions
    • Icons/emojis
    • Snippets

  • About Us page

Release To Do

  • GitHub workflow to build these docs on push/merge
  • GitHub workflow must use strict mode to error on all warnings and errors
  • News article on existing site ahead of release
  • News article with this release