From 92962aa15994e27c8e05f38c826650b8a8091975 Mon Sep 17 00:00:00 2001 From: yuvipanda Date: Wed, 11 Jul 2018 11:53:05 -0700 Subject: [PATCH] Add info about documentation to README --- README.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.rst b/README.rst index 59c7ffe..73ffa70 100644 --- a/README.rst +++ b/README.rst @@ -48,3 +48,19 @@ Ubuntu 18.04. We have a bunch of tutorials to get you started! `_. You should use this if your cloud provider does not already have a direct tutorial, or if you have experience setting up servers. + +Documentation +============= + +Our latest documenation is at: https://the-littlest-jupyterhub.readthedocs.io + +We place a high importance on consistency, readability and completeness of +documentation. If a feature is not documented, it does not exist. If a behavior +is not documented, it is a bug! We try to treat our documentation like we treat +our code: we aim to improve it as often as possible. + +If something is confusing to you in the documentation, it is a bug. We would be +happy if you could `file an issue +`_ about it - or +even better, `contribute a documentation fix +`_!