Add "Edit this page" links to pages in the documentation #107
Labels
documentation
Improvements or additions to documentation
enhancement
New feature or request
triaged
This issue or pull request was triaged
Your proposal or request for the feature
Currently, it is not immediately obvious how you edit the documentation. The current process is
Removing the friction to get to the correct page on Github where you can start the edit process would be beneficial to the health of our documentation.
The proposed feature request is to have a unobtrusive link at the top and/or bottom of the page with the text "Edit this page" or similar that opens a new tab to the correct document in Github. The Github page has a prominent edit button, that when clicked, takes you to the fork the project page to start the process.
Alternatives
None that I can think of.
Additional context
Implementation idea:
Modify the
tools/github_readme_sync
tool to append and/or prepend an "Edit this page" link to the correct page.Modification might fit well here:
tbp.monty/tools/github_readme_sync/readme.py
Line 173 in f93ff45
The link will need to be HTML so that it can be formatted to be smaller than the other links on the page.
The link should open up in a new tab by using the
target="_blank"
attribute on the A tag.Mockup:
It would be nice to see a few different versions of what this should look like to get consensus on the best layout and presentation.
The text was updated successfully, but these errors were encountered: