python / python/mypy

Add a link from mypy's main documentation page to the wiki page

Open
#16,092 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Documentation

mypy's wiki page contains superb documentation. There are links to this page from the mypy-lang.org page and from the mypy repo page, but not from mypy's main (readthedocs.io) documentation page.

Imo, the wiki page deserves a prominent link in the sidebar of mypy's main documentation page.

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

Start at mypy's main Read the Docs page and inspect how its sidebar navigation is configured. Add a prominent link to the mypy wiki page, then verify that the link appears in the published documentation sidebar.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.