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

Version History: A dedicated page for improved navigation and readability #437

Open
6 tasks
rogankool opened this issue Oct 31, 2024 · 5 comments
Open
6 tasks

Comments

@rogankool
Copy link

As a user, I want to access the version history on a dedicated page, so I can view past versions and their comparisons more clearly without multiple pop-ups, ensuring a smoother and more organized experience.

DESCRIPTION (or, dare I say, RATIONALE)
Currently, accessing version history from the Interim Constitution page brings up a modal with a list of past versions. Selecting a version opens another pop-up modal to show a comparison between versions. This process can become cluttered and confusing. By creating a dedicated Version History page, users will have a clearer layout with the version list on the left (similar to the current content list layout on the Interim Constitution page) and the version comparison on the right. This approach will improve usability by providing a more structured view of version history and eliminating the need for multiple modals.

ACCEPTANCE CRITERIA

  • - When a user clicks on the "See version history" button from the Interim Constitution page, they are taken to a new, dedicated Version History page. This should be the only place where you can access the Version History from. Clicking the "back" button will bring you back to the Interim Constitution page, or you can opt out to navigate through the top tab buttons.
  • - The Version History List is displayed on the left side of the page, formatted similarly to the content list on the Interim Constitution page, allowing users to browse and select from past versions.
  • - The Version Comparison Area is on the right side of the page, displaying detailed version comparisons for the version selected from the left list.
  • - Each version in the list should be clickable, displaying the selected version’s comparison on the right side without navigating away or opening additional pop-ups.
  • - Selecting a version from the list updates the comparison section to show changes between the selected version and the previous one. Selecting a version means also that the version should be highlighted in the list on the left.
  • - The Version History page is fully responsive, ensuring that the layout adapts smoothly on both desktop and mobile devices, with the list and comparison areas stacking as necessary on smaller screens.

The previous modal-based version history view is removed, and all version history and comparison details are now accessible only via the new Version History page.

WIREFRAME
Image

@Kale98 Kale98 mentioned this issue Nov 1, 2024
@rogankool
Copy link
Author

@bosko-m we need feedback for this:

  • should we move forward with this dedicated page solution;
  • or should we go back with the modals, as the case was before (just this time using only one, instead of two modals stacked on top of each other)?

@bosko-m
Copy link

bosko-m commented Nov 19, 2024

@rogankool In the version history block, each version has its link and compare button. I assume only two versions can be compared at any point. Is that correct?
Also, just to clarify again after a discussion, comparison should be made in the similar way as in GitHub for example.
Reference for visuals, there is probably a library for this already - https://www.diffchecker.com/

@rogankool
Copy link
Author

@bosko-m

  • Yes, only two versions can be compared at any given point, to be precise: you can only compare a chosen version with the one that precedes it. For example, if you choose version 15, it will be compared to version 14.
  • I will also reference Diffchecker as an example of displaying differences.

@rogankool
Copy link
Author

@bosko-m
By the way, you didn't answer my question on should we stay with the modal system or have a dedicated page?

@bosko-m
Copy link

bosko-m commented Nov 20, 2024

Lets go with the dedicated page as you have described @rogankool .

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

No branches or pull requests

2 participants