python / python/cpython

"Table of Contents" in sidebar always links to complete ToC

Open
#97,679 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs type-bug
Dominant language
Python
Stars
77.2k
Forks
36k
PR merge metrics
PR metrics pending

Description

Documentation

If you open a page of the tutorial, i.e.: https://docs.python.org/3/tutorial/inputoutput.html and click on the left pane link:
Table of Contents
Then you are directed to https://docs.python.org/3/contents.html . I think that the right link should be:
https://docs.python.org/3/tutorial/index.html

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

Open the tutorial page at docs.python.org/3/tutorial/inputoutput.html and inspect how the left-pane “Table of Contents” link is generated. Compare its current destination with the requested tutorial index at docs.python.org/3/tutorial/index.html, then verify that the sidebar link points to the tutorial contents rather than the complete documentation contents.

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
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.