Open
Description
Improving the turtle graphics documentation via a series of PRs
The turtle graphics module has some comprehensive documentation, but could be improved with some:
- restructuring
- new material aimed at getting users more quickly into a successful experience
I propose to do this via a series of small PRs each targeting a particular incremental improvement.
Pitch
The Turtle graphics module looks like a good place where Diátaxis can be applied. It's quite self-contained, and will be an effective showcase for that kind of work.
I will submit small PRs (some could be very small), so that the purpose of each one is clear, and together they will provide a readable history of how documentation improvement works in practice under Diátaxis.
Linked PRs
- gh-106996: Amend the introduction to the turtle graphics documentation #106997
- gh-106996: Add the basics of a turtle graphics tutorial #107072
- [3.12] gh-106996: Add the basics of a turtle graphics tutorial (GH-107072) #107109
- [3.11] gh-106996: Add the basics of a turtle graphics tutorial (GH-107072) #107110
- gh-106996: Add a how-to section to the turtle documentation #107153
- [3.11] gh-106996: Add a how-to section to the turtle documentation (GH-107153) #107234
- [3.12] gh-106996: Add a how-to section to the turtle documentation (GH-107153) #107233
- gh-106996: Rewrite turtle explanation #107244
- [3.12] gh-106996: Rewrite turtle explanation (GH-107244) #107335
- [3.11] gh-106996: Rewrite turtle explanation (GH-107244) #107336
Metadata
Metadata
Assignees
Projects
Status
No status