docs: point "Edit this page" links to the GitHub editor - #16326
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation “Edit this page” links to open directly in GitHub’s file editor (via edit/master) rather than the read-only file view (via blob/master), affecting both the website-rendered guide docs and the generated API reference docs.
Changes:
- Switch guide docs edit-link base URL from
.../blob/masterto.../edit/masterinscripts/website.js. - Switch API docs edit-link base URL from
.../blob/master/to.../edit/master/indocs/source/api.js.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| scripts/website.js | Updates the computed options.editLink base URL to use GitHub’s editor route for guide pages. |
| docs/source/api.js | Updates the generated data.editLink base URL to use GitHub’s editor route for API reference pages. |
AbdelrahmanHafez
marked this pull request as ready for review
June 10, 2026 12:35
AbdelrahmanHafez
added
the
docs
vkarpov15
approved these changes
Jun 10, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Changes the edit links on docs pages from
blob/mastertoedit/master, so clicking "Edit this page" opens the file in GitHub's editor instead of the read-only view. Covers both the API reference pages (docs/source/api.js) and the guide pages (scripts/website.js).