Skip to content
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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

willingc
Copy link
Contributor

@willingc willingc commented Nov 19, 2023

This PR applies Diataxis structure consistently to the guide's contents. It simplifies the landing page and the main contents sidebar.

CURRENT PR
Screenshot 2023-11-18 at 3 40 42 PM Screenshot 2023-11-18 at 3 40 26 PM

This PR adds section pages for Overview and References:

Screenshot 2023-11-18 at 3 45 16 PM Screenshot 2023-11-18 at 3 46 37 PM

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/

@jeanas
Copy link
Contributor

jeanas commented Nov 21, 2023

I like the simplification of the sidebar.

Would it not be better to move reST files around instead of using ../, even if we need to add redirects? I was a bit confused; I did not think it was even possible in Sphinx to refer to documents outside of a directory from a .. toctree:: directive in a file inside that directory.

@jeanas
Copy link
Contributor

jeanas commented Nov 21, 2023

Also, I'm not sure "Reference" is the best place for the "News" page. Perhaps make an "About" folder for "News" and "Contributing"?

@willingc
Copy link
Contributor Author

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.

@jeanas
Copy link
Contributor

jeanas commented Nov 21, 2023 via email

@willingc
Copy link
Contributor Author

ping @pradyunsg

Copy link
Contributor

@jeanas jeanas left a 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
Copy link
Member

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.

source/overview/index.rst Outdated Show resolved Hide resolved
willingc and others added 2 commits March 3, 2024 15:17
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Co-authored-by: Sviatoslav Sydorenko (Святослав Сидоренко) <[email protected]>
Comment on lines +3 to +5
************
Contributing
************
Copy link
Contributor

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.

Suggested change
************
Contributing
************
************************
Contribute to this guide
************************

key_projects
glossary
support
references/index
contribute
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
contribute
Contributing <contribute>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants