Plant anchors for hunks to create links in doc preview changes #36742
Conversation
This file contains 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
kwankyu
changed the title
|
At some point it may be a good idea to split out this diff script to a separate file (perhaps in |
Done. Thanks for the idea. |
mkoeppe
reviewed
Nov 25, 2023
mkoeppe
reviewed
Nov 25, 2023
mkoeppe
reviewed
Nov 25, 2023
kwankyu
force-pushed
the
p/improve-doc-preview
branch
from
0cf20e9
to
e1388ba
Compare
|
Documentation preview for this PR (built with commit 7b0c670; changes) is ready! 🎉 |
|
|
|
Thanks a lot! |
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.
The "changes" page of the doc preview of a PR lacks links to the actual changed parts of the doc preview. We plant invisible anchors for each hunk of the diffs and use them to create links to the changed parts. A sample page is
https://deploy-preview-36742--sagemath-tobias.netlify.app/changes
Wishlist item: In the diffsite comparison view, the left pane showing the doc preview is scrolled to the changed part while the right pane showing the base doc does not. It would be nice if the right pane shows the corresponding part. But this cannot be implemented now because the base doc cannot be altered for specific doc preview for a PR.
📝 Checklist
⌛ Dependencies