This repository was archived by the owner on Jan 23, 2024. It is now read-only.
feat: add 'Edit this page on GitHub' link #708
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add a link to the end of each page (except changelog) to edit the page in GitHub.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
This is great, @samuliasmala! Thanks for opening this PR 💖 A few things that I've noticed:
To provide a consistent experience, I think leading the user to just the page without the Edit Mode will be better. The users will then chose if they want to fork it, open Visual Studio Code on that page, or use the GitHub editor right there on the spot. |
If user is taken directly to the GitHub edit page user must log in before seeing the file. After authentication the page shown differs depending whether user has write access or fork of the repository.
|
Thanks for the comments! You're correct, the link behavior will indeed vary from user to user so it's better to open the file in reading mode. I've updated the PR accordingly. |
|
Looking good! Thanks @samuliasmala 💖 |
|
@allcontributors please add @samuliasmala for code |
|
I've put up a pull request to add @samuliasmala! 🎉 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Add a link to the end of each page (except changelog) to edit the page on GitHub.
⛳️ Current behavior (updates)
No link from document page to directly edit it
🚀 New behavior
Link added to the end of each page to provide easy way to access and edit the documentation
💣 Is this a breaking change (Yes/No):
No