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

Visual diff UI and options for toggling visual diff mode #1

Open
agjohnson opened this issue Aug 20, 2022 · 2 comments
Open

Visual diff UI and options for toggling visual diff mode #1

agjohnson opened this issue Aug 20, 2022 · 2 comments
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code

Comments

@agjohnson
Copy link
Contributor

I already found myself wanting an easy way to toggle:

  • Diff on/off
  • Subtractions on/off

And probably want some way to link into at least one of these, like:

  • Hook into the flyout menu, or an alternative menu UI for debug level stuff. We've talked about a debug toolbar for RTD concept, but the flyout menu is already existing UI as well.
  • Automatically toggle visual diff mode based on query param, for linking into the view from the dashboard or from a PR review check/etc.

We've discussed combining this with an action for posting the files that have changed in a PR.

@agjohnson agjohnson added Improvement Minor improvement to code Accepted Accepted issue on our roadmap labels Aug 20, 2022
@agjohnson agjohnson moved this to Planned in 📍Roadmap Dec 7, 2022
@benjaoming
Copy link

I'm a big +1 on this, especially the query param 👍

Adding this feature gives a lot more "acceptance for bugs". If the page diff is broken, you can switch off the diff and it won't be in the way.

@humitos
Copy link
Member

humitos commented May 23, 2023

I started this work as part of the new js client at readthedocs/addons#63

@humitos humitos removed this from 📍Roadmap Aug 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Improvement Minor improvement to code
Projects
None yet
Development

No branches or pull requests

3 participants