Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Updating/Publishing the docs/ directory #774
It seems like there was a lot of somewhat-duplicated markdown living there, vs. what was in README; now the README is very different.
Are builds of
Should we move towards setting up e.g. readthedocs.org builds of the docs for each version? Should the README point at those? I generally like that approach, though some way to also publish docs for random non-release SHAs/nightly-snapshots or something would also be good and has been lacking in other projects who've done something like this, e.g. Spark.
The docs are published with the releases. I had hoped that by using simple markdown, the barrier to updating them would be low. Unfortunately, we haven't been updating them once created, e.g.
I'm open to any suggestions about how to do documentation better. I haven't used readthedocs.org so I can't comment from experience. I hope what we choose needs to create standalone docs (e.g. PDF, html, etc) and not be dependent on services.