Skip to content

Rework diff docs #12276

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Rework diff docs #12276

wants to merge 1 commit into from

Conversation

stsewd
Copy link
Member

@stsewd stsewd commented Jun 26, 2025

  • Visual diff is kind of limited to highlighting the differences in the page itself (we already got a user confused about this). I'm suggesting something broader, pull request diff
  • Include more things as limitations
  • Regex aren't supported for ignoring files, what we support are some basic patterns.

I also think we should move the configuration of the feature outside the addon, the addon should only control if the diff menu is visible in the preview or not. The settings like ignored files, base version, if a comment should be posted in the PR should be in the PR form.


📚 Documentation previews 📚

@stsewd
Copy link
Member Author

stsewd commented Jun 26, 2025

@ericholscher let me know what you think, can also try porting some of the improvements over the existing docs without changing the names and structure.

@ericholscher
Copy link
Member

ericholscher commented Jun 27, 2025

@stsewd I think in the future we might want to expand this to diffing between active versions, so I don't think we want to brand this PR diff? We have already talked extensively about branding here, I'd be very hesitant to change it again without a larger discussion.

Overall the copy changes look good though, but we should separate improvements from rebranding discussions, which should happen in an issue or team call, and not a PR.

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.

2 participants