-
Notifications
You must be signed in to change notification settings - Fork 73
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 documentation structure #433
Comments
Great idea! I just watched the Divio pycon talk and think it's a great watch to organize 🙂 |
I saw that talk a while ago and it stayed in the back of my mind all this time. I finally think I digested that enough to come up with this plan. Hope it works! |
This one @mdtanker https://www.youtube.com/watch?v=t4vKPhjcMZg? |
@MGomezN yes thats the one! |
I'm proposing a full reorganization of the documentation based around the Divio system. Instead of a galley and user guide, we would have the following. All of these sections will use the Ensaio data.
Getting started
Tutorial
The tutorial should have several parts that grow in complexity and are meant to be followed in order by someone new to Verde. They can include some notes with further reading but shouldn't try to explain how things work under the hood or anything more advanced than what each one is aiming to tackle (leave that for other sections).
grid
andprofile
methods to get geographic grids/profiles. How to edit the metadata to get proper names. Use the same data. After this, do all of the following tutorials using projections.How to
These should be short and to the point, focused on the problem presented. They can assume that people have done the tutorials.
Explanations
These are meant to explain how things work and why they are that way.
Reference documentation
What we already have.
A lot of the existing docs can be repurposed for this. The only thing I would change are the datasets used, update the writing, and use more notes/hints/etc.
This can be done in parts, one section at a time. When it's all done, we can delete the sphinx-gallery parts and remove the sample data.
The text was updated successfully, but these errors were encountered: