-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
New Docs structure #209
Comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I think we should update the documentation based on the Divio system. This will switch from our current style of a
gallery
andtutorials
to a five category system consisting of:Getting started
,Tutorial
,How-to
,Reference
, andExplanation
. Inspired by this Verde issueSimple cooking analogy to understand these sections:
Tutorial
is a cooking lessonHow-to
is a recipeReference
is a encyclopedia article about an ingredientExplanation
is a book on the history and theory of cookingGetting started
Tutorial
These tutorials should grow in complexity and are meant to be followed in order by someone new to PolarToolkit. They shouldn't try to explain how things work, but just teach by doing.
Loading data (Fetch)
Creating plots (Maps)
Creating profiles (Profile)
Other
How-to
These should be short and to the point, focused on the problem presented. They can assume that people have done the tutorials. Also don't explain things, but allow some flexibility.
Reference
Explaination
These are meant to explain how things work and why they are that way.
The text was updated successfully, but these errors were encountered: