DOC: add main sections to toc #1946
Conversation
shoyer
left a comment
shoyer
left a comment
There was a problem hiding this comment.
Thanks, I've been intending to figure out how to do this for a while now.
doc/index.rst
Outdated
|
|
||
| **Getting Started** | ||
|
|
||
| * :doc:`whats-new` |
There was a problem hiding this comment.
Let's move this to the start of "Help & reference" instead.
There was a problem hiding this comment.
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.
Yeah, I don't know :). We can also just leave it here.
There was a problem hiding this comment.
Yeah that was probably overthinking it :). Moved to to the start of "Help & reference".
* add main sections to toc * move whats new to "help and references" section
3 participants
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.