docs: add documentation for the Compare to Original button... #2575
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
mstykow
reviewed
Feb 19, 2024
USER_GUIDE.md
Outdated
|
|
||
| ### Comparing an Attribution to its original Signal | ||
|
|
||
| If an attribution originates from a signal, a `Compare to Original` button will be displayed in the row of buttons below the attribution details in `Audit` and `Attribution` view. Clicking this button opens a popup, where the package coordinates and legal information of both the current attribution and its original signal are displayed side by side. Fields that have changed are highlighted by colored outlines. |
There was a problem hiding this comment.
in light of the upcoming changes, could you write this in such a way that we don't mention audit/attributon view (or only mention audit view)?
There was a problem hiding this comment.
Sure, I formulated it a bit differently.
mstykow
approved these changes
Feb 19, 2024
… popup Signed-off-by: alexzurbonsen <alexander.zur.bonsen@tngtech.com>
alexzurbonsen
force-pushed
the
docs-diff-popup
branch
from
4894afc to
4a48188
Compare
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.
... alias diff popup
Summary of changes
Add two paragraphs for the compare to original functionality.
No screenshots are added at this moment because more changes are to come in the future.