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

feat(ui): release notes section in settings modal #1068

Merged
merged 38 commits into from
Dec 4, 2024

Conversation

peps
Copy link
Collaborator

@peps peps commented Nov 15, 2024

This PR adds a Release Notes section to the settings modal. The release notes themselves are stored in a markdown file in the public folder called CHANGELOG.md

package.json update - I added a new dependancy react-markdown to parse the markdown file.

The first version in the list is open by default, the rest of the entries are collapsed and can be toggled open.

Aupgrade button is shown if there is a new version of the app available.

CleanShot 2024-11-18 at 16 48 05

CleanShot 2024-11-25 at 18 40 39

CleanShot 2024-11-25 at 18 51 11

@peps peps self-assigned this Nov 15, 2024
@brianp
Copy link
Collaborator

brianp commented Nov 15, 2024

That scroll bar will become infinitely long as we continue. Would it be possible to collapse older sections to create a list of release versions and dates that can be expanded?

@peps
Copy link
Collaborator Author

peps commented Nov 15, 2024

That scroll bar will become infinitely long as we continue. Would it be possible to collapse older sections to create a list of release versions and dates that can be expanded?

Sure, its possible, ill add some custom parsing to make it happen

@peps peps marked this pull request as ready for review November 18, 2024 09:28
src/store/useUIStore.ts Outdated Show resolved Hide resolved
@peps peps marked this pull request as draft November 18, 2024 09:29
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This file was generated using AI, it needs real content before merging.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also re. this file - i wonder if we shouldn't have translated version of it too? 😬

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shanimal08 hm probably... It's not my call, but I personally think we should launch with english first then add multi-lang in a future iteration. Im not sure how complicated it would be to set up this ReleaseNotes.md file with auto-translations and don't want that holding this PR up.

Copy link
Collaborator

@shanimal08 shanimal08 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM & tested - looks great:D

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also re. this file - i wonder if we shouldn't have translated version of it too? 😬

@peps peps changed the title feat(ui): release notes section in settings modal feat(ui): release notes section in settings modal [DNM] Nov 19, 2024
@brianp
Copy link
Collaborator

brianp commented Nov 19, 2024

Additional item talked about today: If we're linking to a remote file it's possible someone on an older version would receive the updated file seeing notes for a version they don't have.

If the version they are on, is older than that of the notes lets add a big Upgrade button/banner.

@peps peps marked this pull request as ready for review December 4, 2024 10:51
@peps peps changed the title feat(ui): release notes section in settings modal [DNM] feat(ui): release notes section in settings modal Dec 4, 2024
@peps peps requested a review from metalaureate December 4, 2024 10:54
@brianp brianp merged commit deb1ee8 into tari-project:main Dec 4, 2024
9 checks passed
@Anziskavds
Copy link

Tested successfully on a MacBook Pro M1 2020 13 inch Sequoia 15.1.1 on Testnet v0.8.7.

@Tas4tari
Copy link

Tas4tari commented Dec 6, 2024

Tested successfully on Windows 11, app version 0.8.7
Screenshot (443)
Screenshot (444)
Screenshot (445)
Screenshot (446)
Screenshot (447)

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.

5 participants