|
1 | | ---- |
2 | | -title: "Python Documentation" |
3 | | -numberOfPeople: "TBA" |
4 | | -pythonLevel: "Any" |
5 | | -contactPerson: |
6 | | - name: "Adam Turner" |
7 | | - github: AA-Turner |
8 | | -links: |
9 | | - - title: "Start Documenting" |
10 | | - url: "https://devguide.python.org/documentation/start-documenting/" |
11 | | - - title: "Helping with Documentation" |
12 | | - url: "https://devguide.python.org/documentation/help-documenting/" |
13 | | - - title: "Easy Issues" |
14 | | - url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" |
15 | | - - title: "Code of Conduct" |
16 | | - url: "https://policies.python.org/python.org/code-of-conduct/" |
17 | | ---- |
18 | | - |
19 | | -Help us improve the Python documentation! |
20 | | - |
21 | | -We'll be working on all parts of the documentation, so all any any changes are |
22 | | -welcome -- from fixing a spelling error to documenting a new feature. |
23 | | - |
24 | | -1. Read |
25 | | - ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) |
26 | | - for a briefing on what happens at sprints in general. This was written for |
27 | | - the PyCon US sprints, but a lot applies here!. |
28 | | -1. Fork and clone the [repository](https://github.com/python/cpython/fork) |
29 | | - **before** arriving at the sprints, to get started faster. |
30 | | -1. Use the |
31 | | - [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) |
32 | | - to set up an environment for contributing to the documentation. |
| 1 | +--- |
| 2 | +title: "Python Documentation" |
| 3 | +numberOfPeople: "TBA" |
| 4 | +pythonLevel: "Any" |
| 5 | +contactPerson: |
| 6 | + name: "Adam Turner" |
| 7 | + github: AA-Turner |
| 8 | +links: |
| 9 | + - title: "Start Documenting" |
| 10 | + url: "https://devguide.python.org/documentation/start-documenting/" |
| 11 | + - title: "Helping with Documentation" |
| 12 | + url: "https://devguide.python.org/documentation/help-documenting/" |
| 13 | + - title: "Easy Issues" |
| 14 | + url: "https://github.com/python/cpython/issues?q=is%3Aissue%20is%3Aopen%20label%3Adocs%20label%3Aeasy" |
| 15 | + - title: "Code of Conduct" |
| 16 | + url: "https://policies.python.org/python.org/code-of-conduct/" |
| 17 | +--- |
| 18 | + |
| 19 | +Help us improve the Python documentation! |
| 20 | + |
| 21 | +We'll be working on all parts of the documentation, so all any any changes are |
| 22 | +welcome -- from fixing a spelling error to documenting a new feature. |
| 23 | + |
| 24 | +1. Read |
| 25 | + ['what to expect'](https://pycon.blogspot.com/2025/04/pyconus-sprints.html) |
| 26 | + for a briefing on what happens at sprints in general. This was written for |
| 27 | + the PyCon US sprints, but a lot applies here!. |
| 28 | +1. Fork and clone the [repository](https://github.com/python/cpython/fork) |
| 29 | + **before** arriving at the sprints, to get started faster. |
| 30 | +1. Use the |
| 31 | + [Python Developer's Guide](https://devguide.python.org/getting-started/setup-building/) |
| 32 | + to set up an environment for contributing to the documentation. |
0 commit comments