Added edit this page option in the footer#157
Conversation
aaronbrethorst
left a comment
There was a problem hiding this comment.
Hey gg7767, thanks for taking the time to add a way for users to give feedback from the docs site. Getting a link into the footer is a solid idea and the right place for it. Before we can merge this, I will need you to make a couple changes:
Critical
-
The label "Edit this page" is misleading. The link goes to GitHub's generic new-issue form, but "Edit this page" is a well-established convention in documentation sites (React docs, MDN, Docusaurus, etc.) that means "open the source file on GitHub so I can propose a direct edit." Users will be confused when they land on an issue form instead. Please either:
- Option A: Rename the link to something like "Report an issue" and swap the pencil icon for something more appropriate (e.g. a flag or bug icon), or
- Option B: Make it a true "Edit this page" link that points to the actual source file on GitHub (e.g.
https://github.com/OneBusAway/onebusaway-docs/edit/main/src/...)
-
The link isn't page-specific. Every page on the site will link to the exact same generic
/issues/newURL with no context about which page the user was on. At minimum, please pass query parameters to pre-fill the issue with the page title and URL, e.g.:https://github.com/OneBusAway/onebusaway-docs/issues/new?title=Feedback:+Page+Title&body=Page:+https://developer.onebusaway.org/the-page-urlThis makes reports much more useful for maintainers.
Important
-
Indentation is inconsistent. The existing file uses 2-space indentation. The children of your new wrapper
<div>should be indented 2 spaces deeper than the wrapper itself, and the closing</div>should be at the same level as the opening tag. Right now the nesting doesn't match. -
Missing accessibility attributes. Every other external link in the footer has a
titleattribute (e.g.title="Follow us on GitHub"), and the SVGs usearia-hidden="true". Please add both to your new link and icon to match the established pattern.
If you need to rebase your branch against main, here's a blog post I wrote to help demystify the process: https://www.brethorsting.com/blog/2026/01/git-rebase-for-the-terrified/
Thanks again, and I look forward to merging this change.
Fixed #156
Added the edit page option on the homepage which links to the docs github to create a new issue.