-
-
Notifications
You must be signed in to change notification settings - Fork 11k
DOC: Discussion - How to organize tutorials #19191
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
Comments
I'm in favor of (2). Duplicated content doesn't make sense. Having a clear split between User Guide and |
My NumPy Docs page redesign proposal would change the main docs/sphinx front page, Getting Started and User Guide page. I'm also in favor 2). With sphinx tutorials page, I didn't include it in my redesign at first since there was so sparse and I wasn't sure how to/if needed to arrange 2 items. With 2), the main docs/sphinx pages would still act as the first entryway, and even if a user ultimately needs numpy-tutorials, the redesign will help them get there. Redesigned Docs front page:
This flow could like look like this: Docs front page -> User Guide page -> Tutorials, which would link to numpy-tutorials. Tutorials could be linked from multiple pages: Tutorials could also be linked on the front page, but I think adding more categories brings up the re-occurring issue of similar sounding words for different concepts, which may be confusing. Redesigned Docs front page:
Maybe the description text under the Tutorials heading here could be This is getting long, so perhaps a visual prototype of what I'm talking about would help, haha. |
PR above has my proposal for now. Once the new landing page is here, we can reorganize if needed. Thanks! |
Documentation
Now that https://numpy.org/numpy-tutorials/ is deployed, we need to decide how to organize our internal documentation.
Currently, this page is also called NumPy Tutorials. The two tutorials listed there are also available as Jupyter Notebooks from the separate numpy-tutorials repo.
In our docs team meetings, we have discussed two possibilities:
It would be nice to have further input from the community so we can reach a solution. If you have other ideas, please feel free to let us know!
cc @rossbar @rgommers @cooperrc @8bitmp3
The text was updated successfully, but these errors were encountered: