Updating writers' docs

Updating the writers' guide

We use readthedocs to generate a website that provides documentation for those interesting in creating games. See: https://lives-in-transit.readthedocs.io

This is hooked up so that any time the docs change in the master branch of this repo, the site will get updated.

We can even configure these docs to serve from inside our livesintransit.org domain one day (i.e. there could be livesintransit.org/writers that brings up this page). But that'll take some doing, not needed yet.

For anyone wishing to add content to these docs, here's what you need to know:

docs folder

The docs folder of this repo is where all the documentation files are kept. Each file represents an entry in the table of contents as seen on the left. You can use heading depth 1 (i.e. # Header, or 2 (## Smaller header), but beyond that might not behave exactly as you want.

If you want to create a new page (and therefore, a new entry in the TOC), you have to update:

1. mkdocs.yml <- the configuration for the project in general
2. docs/index.md <- the main page of the docs, which also has its own contents appearing (though it's a bit redundant and we could remove if we want to simplify things even more)

What does this mean for lit-tutorial?

The tutorial is an awesome resource. It will need to go on the live system for it to be much use I guess, and could be referred to frequently in the writers' docs. But since both systems are doing similar things, I think it's important to link between them wherever possible, rather than treat them as alternatives to one-another.

readthedocs

If you make an account on readthedocs.io, I can turn you into a collaborator there, which gives you some control over the build process (i.e. you can trigger them for a branch you're working on, or something). But mostly this isn't needed, you can just keep working as you did, plus now also adding documentation as you see fit.