-
Notifications
You must be signed in to change notification settings - Fork 10
Description
See #8 for context.
I think the Python documentation is a good source of inspiration. There are some nice features here:
The documentation is available by release version. For example, if you're using Python 3.5 instead of 3.6, you can find the latest 3.5 version (i.e. 3.5.3) docs here.
The landing page has big links to the most relevant information, like the changelog, a tutorial, installation instructions, an FAQ, etc.
As you navigate through the docs, there is a sidebar with quick links to each section, making it easy to zero in on a particular section.
I previously looked into http://readthedocs.io, and it seems like a nice way to set up something like this. I did a quick port of our existing documentation here: http://alda.readthedocs.io/en/latest/
The docs are actually generated from the alda-lang/alda repo, which is great because we can still keep the docs version controlled alongside the source code, and easily generate different versions of the documentation based on Alda release versions.
The next steps are to organize the docs better so that they look good on readthedocs.io, and then we could CNAME the docs to something like http://docs.alda.io and include a link on the website.