René's URL Explorer Experiment


Title: Feature: move the "quick reference" from the devguide root to a dedicated page under Getting Started · Issue #1837 · python/devguide · GitHub

Open Graph Title: Feature: move the "quick reference" from the devguide root to a dedicated page under Getting Started · Issue #1837 · python/devguide

X Title: Feature: move the "quick reference" from the devguide root to a dedicated page under Getting Started · Issue #1837 · python/devguide

Description: Describe the enhancement or feature you would like As the root page has evolved, it has become more clearly an index page, with some high level content but not much detailed documentation, leaving that for other pages. Technical guidance...

Open Graph Description: Describe the enhancement or feature you would like As the root page has evolved, it has become more clearly an index page, with some high level content but not much detailed documentation, leaving ...

X Description: Describe the enhancement or feature you would like As the root page has evolved, it has become more clearly an index page, with some high level content but not much detailed documentation, leaving ...

Opengraph URL: https://github.com/python/devguide/issues/1837

X: @github

direct link

Domain: github.com


Hey, it has json ld scripts:
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Feature: move the \"quick reference\" from the devguide root to a dedicated page under Getting Started","articleBody":"### Describe the enhancement or feature you would like\n\nAs the root page has evolved, it has become more clearly an index page, with some high level content but not much detailed documentation, leaving that for other pages. Technical guidance at the level of \"run this command\" no longer belongs at the root of the docs, except perhaps in summary fashion.\n\nI think we should add a new page to the Getting Started docs, but *after* \"Setup and building\" in doc order. The intention being that this is explicitly *not* a \"quickstart guide\", and treating it as such should be subtly discouraged.\n\n### Describe alternatives you have considered\n\nInitially, I intended to propose we remove the section. The content it covers *is* fully captured by other pages.\nHowever, the \"quick reference\" is, itself, unusual in that it spans the concerns of cloning, building, testing, running `blurb`, and opening a PR. For a new contributor, who may have done only 1-2 PRs already, having an easy reference doc which fits on one page, especially as reminders for those final steps, is useful.\n\nI also weighed the possibility of subtly changing the purpose of the doc, from \"Quick Reference\" to \"Quickstart\". There are two reasons I rejected the idea. First, the target audience for this doc is not, in my opinion, brand new contributors. It's for newer or infrequent contributors who benefit from having an easy reference to things they've already learned. The second reason is that the typical implication of a \"quickstart\" guide is that \"you follow these steps and you'll be ready\", which seems like the wrong message to send to new contributors.\n\n### Additional context\n\nThis was inspired out of a discord conversation ([ref](https://discord.com/channels/935215565872693329/935219976481161216/1515465671733940338)). @nedbat noted that [the \"quick reference\" section](https://devguide.python.org/#quick-reference) in the index doc is not well-placed. I agree, and think there are a couple of options for what to do.\n\nAt first, I thought it was _just_ a git reference doc, and intended to propose removal. Looking closely, I think there is a useful thing here worth preserving. I had never -- as a new contributor -- looked at this bit of doc, and there are subtle details in it which are good reminders! e.g.,\n```bash\n./python -m test -j3\n```\nreminds me that I can pass `-j \u003cN>` to the testsuite.","author":{"url":"https://github.com/sirosen","@type":"Person","name":"sirosen"},"datePublished":"2026-06-13T22:38:56Z","url":"https://github.com/python/devguide/issues/1837"}

react-profiling0
react-import-mapreact,react-dom,react-dom/client,react-dom/profiling,react-is,react/compiler-runtime,react/jsx-dev-runtime,react/jsx-runtime,scheduler@b8488ee2c322
route-pattern/_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format)
route-controllervoltron_issues_fragments
route-actionissue_layout
fetch-noncev2:f3d01826-a8cf-3d0b-0422-dceb6be5e671
current-catalog-service-hash81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114
request-idD290:29AEE8:3550CFD:46FD74F:6B020211
html-safe-nonce98aa3607eca05c8ec78b27769bb6fc9db944a6af29e00ea9e712430addcabd35
visitor-payloadeyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJEMjkwOjI5QUVFODozNTUwQ0ZEOjQ2RkQ3NEY6NkIwMjAyMTEiLCJ2aXNpdG9yX2lkIjoiODcwNjc4MTMxNzk3NjY4NzEyMSIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9
visitor-hmac6ac0cf6d2f426d2fe6766ae2c548cf74e7737a9bab0ed04030eae147bacbc08e
hovercard-subject-tagissue:4657175204
github-keyboard-shortcutsrepository,issues,copilot
google-site-verificationApib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I
octolytics-urlhttps://collector.github.com/github/collect
analytics-location///voltron/issues_fragments/issue_layout
fb:app_id1401488693436528
apple-itunes-appapp-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/python/devguide/1837/issue_layout
twitter:imagehttps://opengraph.githubassets.com/6419062b0b043aa534c2be53ee248348a2768a445ff30a09afbb90f7fcc06a26/python/devguide/issues/1837
twitter:cardsummary_large_image
og:imagehttps://opengraph.githubassets.com/6419062b0b043aa534c2be53ee248348a2768a445ff30a09afbb90f7fcc06a26/python/devguide/issues/1837
og:image:altDescribe the enhancement or feature you would like As the root page has evolved, it has become more clearly an index page, with some high level content but not much detailed documentation, leaving ...
og:image:width1200
og:image:height600
og:site_nameGitHub
og:typeobject
og:author:usernamesirosen
hostnamegithub.com
expected-hostnamegithub.com
None87e774ee7c6b3bee0490394e4d3e57ec9dbc956f74b87ea685dc8996c1676456
turbo-cache-controlno-preview
go-importgithub.com/python/devguide git https://github.com/python/devguide.git
octolytics-dimension-user_id1525981
octolytics-dimension-user_loginpython
octolytics-dimension-repository_id63972479
octolytics-dimension-repository_nwopython/devguide
octolytics-dimension-repository_publictrue
octolytics-dimension-repository_is_forkfalse
octolytics-dimension-repository_network_root_id63972479
octolytics-dimension-repository_network_root_nwopython/devguide
turbo-body-classeslogged-out env-production page-responsive
disable-turbofalse
browser-stats-urlhttps://api.github.com/_private/browser/stats
browser-errors-urlhttps://api.github.com/_private/browser/errors
release423dbb54c5e7bfecc838eb387c1435eb3d0e760d
ui-targetfull
theme-color#1e2327
color-schemelight dark
react-app-nameissues

Links:

Skip to contenthttps://github.com/python/devguide/issues/1837#start-of-content
https://github.com/
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fissues%2F1837
GitHubRepository hosting, code review, and collaborationhttps://github.com/platform
CopilotAI coding agent for tasks, projects, and automated workhttps://github.com/features/copilot
ActionsCI/CD and automationhttps://github.com/features/actions
Code QualityQuality analysis, fixes, and enforcementhttps://github.com/features/code-quality
CodespacesCloud development environmentshttps://github.com/features/codespaces
Code SecurityVulnerability detection and remediationhttps://github.com/security/advanced-security/code-security
Secret ProtectionSecret scanning and leak preventionhttps://github.com/security/advanced-security/secret-protection
All Featureshttps://github.com/features
Documentationhttps://docs.github.com/en
Traininghttps://learn.github.com/skills
Certificationshttps://learn.github.com/credentials
Build with Copilothttps://github.com/features/ai
Customize Copilothttps://docs.github.com/en/copilot/how-tos/copilot-on-github/customize-copilot/customize-copilot-overview
Integrationshttps://github.com/marketplace
Trending reposhttps://github.com/trending
GitHub Sponsorshttps://github.com/open-source/sponsors
Developer articleshttps://github.com/resources/articles
ChangelogYour source for the latest features, improvements, and fixes across GitHub products, all in one place.https://github.blog/changelog/
Enterpriseshttps://github.com/enterprise
Teamhttps://github.com/team
Startupshttps://github.com/enterprise/startups
Nonprofitshttps://github.com/solutions/industry/nonprofits
Healthcarehttps://github.com/solutions/industry/healthcare
Financial serviceshttps://github.com/solutions/industry/financial-services
Manufacturinghttps://github.com/solutions/industry/manufacturing
Governmenthttps://github.com/solutions/industry/government
See all industrieshttps://github.com/solutions/industry
Why GitHubhttps://github.com/why-github
Customer Storieshttps://github.com/customer-stories
Business insightshttps://github.com/solutions/executive-insights
Trust Centerhttps://github.com/trust-center
GitHub Advanced SecurityEnterprise-grade code securityhttps://github.com/security/advanced-security
Copilot for businessEnterprise-grade AI featureshttps://github.com/features/copilot/copilot-business
Premium SupportEnterprise-grade 24/7 supporthttps://github.com/enterprise/premium-support
Documentationhttps://docs.github.com/en
Resource centerhttps://github.com/resources
Bloghttps://github.blog/
Events & webinarshttps://github.com/resources/events
Community Forumhttps://github.com/orgs/community/discussions
Customer Storieshttps://github.com/customer-stories
Integrationshttps://github.com/marketplace
Customer supporthttps://help.github.com/
Traininghttps://learn.github.com/skills
GitHub Statushttps://www.githubstatus.com/
Abouthttps://github.com/about
Partnershttps://github.com/partners
Changeloghttps://github.blog/changelog/
GitHub UniverseThe event for developers, by developers — talks, workshops, and what’s next for GitHub.https://githubuniverse.com/
Pricinghttps://github.com/pricing
Sign inhttps://github.com/login?return_to=https%3A%2F%2Fgithub.com%2Fpython%2Fdevguide%2Fissues%2F1837
Sign uphttps://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F%3Cuser-name%3E%2F%3Crepo-name%3E%2Fvoltron%2Fissues_fragments%2Fissue_layout&source=header-repo&source_repo=python%2Fdevguide
Reloadhttps://github.com/python/devguide/issues/1837
Reloadhttps://github.com/python/devguide/issues/1837
Reloadhttps://github.com/python/devguide/issues/1837
pythonhttps://github.com/python
devguidehttps://github.com/python/devguide
Codehttps://github.com/python/devguide
Issues83 (83)https://github.com/python/devguide/issues
Pull requests41 (41)https://github.com/python/devguide/pulls
Actionshttps://github.com/python/devguide/actions
Projectshttps://github.com/python/devguide/projects
Security and qualityhttps://github.com/python/devguide/security
Insightshttps://github.com/python/devguide/insights
https://github.com/python/devguide
New issuehttps://github.com/login?return_to=https://github.com/python/devguide/issues/1837
New issuehttps://github.com/login?return_to=https://github.com/python/devguide/issues/1837
#1838https://github.com/python/devguide/pull/1838
Feature: move the "quick reference" from the devguide root to a dedicated page under Getting Startedhttps://github.com/python/devguide/issues/1837#top
#1838https://github.com/python/devguide/pull/1838
type-refactorReorganization of contents in devguidehttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-refactor%22
https://github.com/sirosen
sirosenhttps://github.com/sirosen
on Jun 13, 2026https://github.com/python/devguide/issues/1837#issue-4657175204
refhttps://discord.com/channels/935215565872693329/935219976481161216/1515465671733940338
@nedbathttps://github.com/nedbat
the "quick reference" sectionhttps://devguide.python.org/#quick-reference
sirosenhttps://github.com/sirosen
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
on Jun 13, 2026https://github.com/python/devguide/issues/1837#event-26716361047
StanFromIrelandhttps://github.com/StanFromIreland
type-refactorReorganization of contents in devguidehttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-refactor%22
type-featureAdditions; New content or section neededhttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-feature%22
on Jun 15, 2026https://github.com/python/devguide/issues/1837#event-26754628776
https://github.com/ezio-melotti
ezio-melottihttps://github.com/ezio-melotti
on Jun 22, 2026https://github.com/python/devguide/issues/1837#issuecomment-4770230745
Add "Quick Start" section to the devguide index cpython#57437https://github.com/python/cpython/issues/57437
willingchttps://github.com/willingc
completedhttps://github.com/python/devguide/issues?q=is%3Aissue%20state%3Aclosed%20archived%3Afalse%20reason%3Acompleted
#1838https://github.com/python/devguide/pull/1838
on Jun 25, 2026https://github.com/python/devguide/issues/1837#event-27210456636
Sign up for freehttps://github.com/signup?return_to=https://github.com/python/devguide/issues/1837
Sign in to commenthttps://github.com/login?return_to=https://github.com/python/devguide/issues/1837
type-refactorReorganization of contents in devguidehttps://github.com/python/devguide/issues?q=state%3Aopen%20label%3A%22type-refactor%22
https://github.com
Termshttps://docs.github.com/site-policy/github-terms/github-terms-of-service
Privacyhttps://docs.github.com/site-policy/privacy-policies/github-privacy-statement
Securityhttps://github.com/security
Statushttps://www.githubstatus.com/
Communityhttps://github.community/
Docshttps://docs.github.com/
Contacthttps://support.github.com?tags=dotcom-footer

Viewport: width=device-width


URLs of crawlers that visited me.