Skip to content

Enhancement: Improve Visibility and Naming Consistency of "Developer's Guide" on the Main Website Navigation #2727

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

Open
hong539 opened this issue May 8, 2025 · 2 comments
Labels
enhancement This is an improvement to existing code or configuration

Comments

@hong539
Copy link

hong539 commented May 8, 2025

Is your feature request related to a problem? Please describe.

When navigating the Python Official Website, I found it challenging to locate the Developer Guide (https://www.python.org/dev/). It is currently listed under the footer in the "Contributing" section, which is not intuitive for new developers or contributors.

Additionally, there are two separate links labeled as "Developer's Guide":

  • One under Documentation
  • One under Contributing

This duplication is confusing, as it is unclear if they lead to the same resource or represent different aspects of the development process.

Image

Describe the solution you'd like

To improve usability and reduce confusion, I recommend the following enhancements:

  1. Rename the links under different sections:

    • Under Documentation, rename Developer's Guide to Developer Resources or Development Documentation.
    • Under Contributing, rename Developer's Guide to Contribution Guide.
  2. Improve visibility:

    • Consider adding Developer Resources or Developer's Guide directly to the main navigation bar, alongside Documentation and Community.
  3. Merge or clarify:

    • If both links are pointing to the same location (https://www.python.org/dev/), consider consolidating them to one prominent link.
    • If they are different, a clear description should be added to each to explain their purpose.

Basic Example

No response

Describe alternatives you've considered

No response

Drawbacks and Impact

No response

Additional context

No response

@hong539 hong539 added the enhancement This is an improvement to existing code or configuration label May 8, 2025
@hugovk
Copy link
Member

hugovk commented May 8, 2025

  • If both links are pointing to the same location (https://www.python.org/dev/), consider consolidating them to one prominent link.

Both point to the same location, but it's the new address (https://devguide.python.org/). Perhaps your LLM hasn't scraped the website recently?

@hong539
Copy link
Author

hong539 commented May 8, 2025

  • If both links are pointing to the same location (https://www.python.org/dev/), consider consolidating them to one prominent link.

Both point to the same location, but it's the new address (https://devguide.python.org/). Perhaps your LLM hasn't scraped the website recently?

OK,I think problem is that Why the "Contributing" button will go the URL: "https://www.python.org/dev/"
But, there will show me that "Python Developer's Guide" but not "Contributing Guide" or something else.
:(

Image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This is an improvement to existing code or configuration
Projects
None yet
Development

No branches or pull requests

2 participants