-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
DOC: add main sections to toc #1946
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I've been intending to figure out how to do this for a while now.
doc/index.rst
Outdated
@@ -32,14 +31,44 @@ describing scientific data in widespread use in the Earth sciences: | |||
Documentation | |||
------------- | |||
|
|||
**Getting Started** | |||
|
|||
* :doc:`whats-new` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's move this to the start of "Help & reference" instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or move it to the very end? I kind of like a linear flow from new user to contributor (i.e., getting started -> user guide -> api -> developer zone...) and keep "what's new" out of that.
Also, a "what's new" section at the bottom of the toc may sound a little bit weird. Maybe rename it to "Release Notes"?
For example pandas has both "What's new" at the top and "Release Notes" at the bottom. I like it but I don't think we need both in xarray, though.
No strong opinion on this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I don't know :). We can also just leave it here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah that was probably overthinking it :). Moved to to the start of "Help & reference".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Digging it. Thanks @benbovy.
* add main sections to toc * move whats new to "help and references" section
Not a big change, but adds a little more clarity IMO.
I'm open to any suggestion for better section names and/or organization. Also I let "What's new" at the top, but not sure if "Getting started" is the right section.