Move the "quick reference" to a dedicated page#1838
Open
sirosen wants to merge 1 commit into
Open
Conversation
A new page at `Getting Started > Quick Reference` is added to contain the (moved) content which was in the Quick Reference section of the index document for the site. The content is left almost entirely untouched, but the introductory text is slightly altered to de-emphasize use of the doc for new contributors. Intentionally, as described in python#1837, the page is placed in Getting Started but after the setup guide.
Documentation build overview
5 files changed ·
|
| Here are the basic steps needed to get set up and open a pull request. | ||
|
|
||
| This is meant as a checklist and cheat-sheet, not a comprehensive guide. | ||
| For complete instructions please see the :ref:`setup guide <setup>`. |
Member
There was a problem hiding this comment.
I don't think this makes sense now, we redirect people back to the page they've just read?
|
|
||
| PCbuild\build.bat -e -d | ||
|
|
||
| See also :ref:`more detailed instructions <compiling>`, |
Member
There was a problem hiding this comment.
All of the above steps should have been completed by the time they reach this page, so we don't quite need them.
|
|
||
| .\python.bat -m test -j3 | ||
|
|
||
| 5. Create a new branch where your work for the issue will go, for example:: |
Member
There was a problem hiding this comment.
This section is duplicated by our other "Quick guide".
hugovk
reviewed
Jun 14, 2026
| .. _quick-reference: | ||
|
|
||
| =============== | ||
| Quick Reference |
Member
There was a problem hiding this comment.
Use sentence case for headers:
https://devguide.python.org/documentation/style-guide/#capitalization
Suggested change
| Quick Reference | |
| Quick reference |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A new page at
Getting Started > Quick Referenceis added to contain the(moved) content which was in the Quick Reference section of the index
document for the site.
The content is left almost entirely untouched, but the introductory text
is slightly altered to de-emphasize use of the doc for new contributors.
Intentionally, as described in #1837, the page is placed in Getting
Started but after the setup guide.
closes #1837