-
Notifications
You must be signed in to change notification settings - Fork 932
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
Restructure table of contents, section indices, and landing page #1409
base: main
Are you sure you want to change the base?
Conversation
I like the simplification of the sidebar. Would it not be better to move reST files around instead of using |
Also, I'm not sure "Reference" is the best place for the "News" page. Perhaps make an "About" folder for "News" and "Contributing"? |
Since "News" is a historical page that we likely won't continue, I tossed it under Reference. |
In that case, maybe we should just orphan the page?
|
ping @pradyunsg |
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 try to move this forward? I'm approving the PR, we can move documents and add redirects later, when we've solved #1408.
@@ -1,8 +1,8 @@ | |||
.. |PyPUG| replace:: Python Packaging User Guide | |||
|
|||
************************ | |||
Contribute to this guide |
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.
Should this be changed? We could update just the ToC entry text instead.
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
************ | ||
Contributing | ||
************ |
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.
I agree with @webknjaz on that.
************ | |
Contributing | |
************ | |
************************ | |
Contribute to this guide | |
************************ |
key_projects | ||
glossary | ||
support | ||
references/index | ||
contribute |
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.
contribute | |
Contributing <contribute> |
This PR applies Diataxis structure consistently to the guide's contents. It simplifies the landing page and the main contents sidebar.
This PR adds section pages for Overview and References:
Finally the content in the landing page has been simplified and aligned to a Diataxis structure.
📚 Documentation preview 📚: https://python-packaging-user-guide--1409.org.readthedocs.build/en/1409/