Edit on GitHub consistent and on all pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9.3k
- Forks
- 4.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 4
Description
Various links to GitHub exist in multiple places:
- In the top horizontal nav:
-
On some tutorials pages that have auto generated call to action links, like here
(https://pytorch.org/tutorials/intermediate/pipeline_tutorial.html):
-
We can add replace the "view source" link in the doc theme (conf.py -
hmtl_contenxt) with the Edit on GitHub button (if it actually works):
However, then we can end up having three Edit/View on GitHub links on some pages.
Need to solve this on all docs/tutorials sites:
- Each page should have a link to editing
- There should be no duplicate links
cc: @malfet @holly1238
cc @carljparker
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inventorying the GitHub links in the top horizontal navigation, autogenerated tutorial call-to-action links, and the documentation theme configuration in conf.py, including html_contenxt. Determine which pages expose each link and check whether the theme's edit link works. Done means every documentation and tutorial page has one editing link with no duplicates.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100