Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add "Edit this page" links to pages in the documentation #107

Open
codeallthethingz opened this issue Dec 9, 2024 · 3 comments
Open

Add "Edit this page" links to pages in the documentation #107

codeallthethingz opened this issue Dec 9, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request triaged This issue or pull request was triaged

Comments

@codeallthethingz
Copy link
Contributor

codeallthethingz commented Dec 9, 2024

Your proposal or request for the feature

Currently, it is not immediately obvious how you edit the documentation. The current process is

  • find the page in the repo on Github.
  • click edit
  • fork the repo
  • make your changes
  • open a PR

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:


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:
image

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.

@codeallthethingz codeallthethingz added the enhancement New feature or request label Dec 9, 2024
@tristanls tristanls added the triaged This issue or pull request was triaged label Dec 9, 2024
@tristanls
Copy link
Contributor

tristanls commented Dec 9, 2024

This is a good idea.

We could make the edit link more prominent.

Example of how GitHub does it:

Screenshot 2024-12-09 at 10 04 11

@codeallthethingz
Copy link
Contributor Author

codeallthethingz commented Dec 9, 2024

This is a good idea.

We could make the edit link more prominent.

Example of how GitHub does it:

I have never noticed that huge call to action. :)

Maybe its that I expect edit links to be tiny and in the page because I'm a nerd.

@vkakerbeck
Copy link
Contributor

That's a nice idea!
If we make it a bit more than a small link like @tristanls suggests, it would have the advantage that we can additionally link to the guide on how to edit the documentation (like the "Learn how to contribute" button in the screenshot). But I agree with you @codeallthethingz that somehow the single small link makes my brain happier to see and for some reason makes me want to click on it more :D Either way will be nice to have.

@codeallthethingz codeallthethingz added the documentation Improvements or additions to documentation label Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request triaged This issue or pull request was triaged
Projects
None yet
Development

No branches or pull requests

3 participants