Skip to content

Added edit this page option in the footer#157

Open
gg7767 wants to merge 1 commit intoOneBusAway:mainfrom
gg7767:main
Open

Added edit this page option in the footer#157
gg7767 wants to merge 1 commit intoOneBusAway:mainfrom
gg7767:main

Conversation

@gg7767
Copy link

@gg7767 gg7767 commented Mar 21, 2025

Fixed #156
Added the edit page option on the homepage which links to the docs github to create a new issue.

@CLAassistant
Copy link

CLAassistant commented Mar 21, 2025

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@aaronbrethorst aaronbrethorst left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. 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/...)
  2. The link isn't page-specific. Every page on the site will link to the exact same generic /issues/new URL 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-url
    

    This makes reports much more useful for maintainers.

Important

  1. 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.

  2. Missing accessibility attributes. Every other external link in the footer has a title attribute (e.g. title="Follow us on GitHub"), and the SVGs use aria-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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

feat: Add "Edit this page" Button

3 participants

Comments