python / python/devguide

Post-migration Devguide reorganization

Open
#120 10 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type-feature type-refactor
Dominant language
Python
Stars
2.1k
Forks
1k
Avg merge
2d 12h
Merged PRs (30d)
12

Description

I think the Devguide is due for some reorganization after the migration.

In particular:

The other pages don't have any major issue :)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the unchecked Devguide pages listed in the issue, especially runtests, silence warnings, fixing easy issues, help and communication channels, and adding to the stdlib. First confirm which completed items and referenced issues still reflect the current site, then determine the remaining page moves and content updates. Done means an agreed reorganization is implemented and the affected links and navigation remain coherent.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.