Skip to content

Random walk documentation improvements #107432

Open

Description

@evildmp

Across the documentation there are numerous examples of scope for improvement. Many of these could be described as housekeeping opportunities - documentation that is fundamentally sound, but needs to be updated and tidied up.

An example is Porting Python 2 Code to Python 3, which was written in a different era.

These are the kind of thing that will be discovered in a random walk through the documentation, one thing leading to another. A random walk will also uncover (often small) possibilities for improvement that would otherwise likely hide unnoticed in quiet corners.

Pitch

I propose taking a random walk through the documentation, finding and taking low-hanging fruit where I go. As well as the value of the fixes themselves, the activity and discussion of issues as they come up with bring further opportunities to the surface, and place them in front of more eyes.

Discoveries and suggestions

Linked PRs

Activity

  1. added 3 commits that reference this issue on Jul 29, 2023
  2. added a commit that references this issue on Aug 5, 2023
  3. added 2 commits that reference this issue on Aug 5, 2023
  4. added a commit that references this issue on Aug 5, 2023
  5. added a commit that references this issue on Aug 5, 2023
  6. added a commit that references this issue on Aug 24, 2023
  7. added a commit that references this issue on Aug 24, 2023
  8. added a commit that references this issue on Aug 24, 2023
  9. added a commit that references this issue on Aug 24, 2023
  10. added a commit that references this issue on Aug 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions