-
-
Notifications
You must be signed in to change notification settings - Fork 60
Link to developer guide in CPython repo description #30
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
There's no good way to provide two links in the repo title as that link is a specific, separate field from the description. |
In that case, I'll rephrase the proposal to suggest linking to the developer guide instead of linking to python.org :) |
The question becomes what do people use that link for? I personally use it to validate that I'm looking at the project that's behind a certain website or to get to the homepage quickly, not to get to developer documentation. I always assume the README and/or CONTRIBUTING files will have the dev doc links. |
🤔 Maybe instead of www.python.org, it should be pointing to docs.python.org? |
I think we are all way over-thinking a single link 😉 . Maybe it would be better to just have 3 quick links listed at the top of the README: www.python.org, docs.python.org, and the devguide. |
Sounds good to me :) |
@Mariatta's addition looks good to me, and should be useful to folks looking at the README offline as well. As far as the project level link goes, I think the reason it bugs me is just because our top level directory and file listing is long enough to push the start of the README off the bottom of the page. And yes, I'm almost certainly overthinking it :) |
Since Mariatta's proposed PR was merged I'm closing this. |
python/cpython#118 adds a link to the Developer Guide to the top of the README.
It would be useful if the repo description linked to the developer guide in addition to linking to the main python.org website.
The text was updated successfully, but these errors were encountered: