Add Change Log into About panel #83
Conversation
There was a problem hiding this comment.
🎉 Whoa, first pull request alert!
Huge thanks for taking the leap and contributing to Text Forge. Your involvement fuels the spirit of modularity, clarity, and collaboration that drives this project. We’ll be reviewing your work with care—expect thoughtful feedback soon! 🧠💬
Welcome aboard, and let's keep crafting the future of text editing.
|
That probably should be an Action Script instead of a standalone script, but I honestly don't quite fully understand how the Action Scripts should be implemented to make it work. |
|
Hi @Wiechciu, welcome to Text Forge! Your witk looks great and fast, I will make a better look very soon. But for now, there is a mistake from me, #34 isn't about add project chagelogs in about window (I should write some information in issues...), It's about add features in editor to make writing changelogs easier for users. But changelog tab in about is a good feature, so we will merge it. Also, please add this feature in CHANGELOG.md if is ready. Great work! |
|
@mkh-user Alright, thanks! |
Pull Request Template
Title
Add Change Log into About panel
Type of Change
Description
This closes #34
Added a new tab into the About panel.
The text is loaded from the CHANGELOG.md file.
The text is converted from markdown to bbcode style with RegEx for headers, bold style, inline code, links and lists.
Testing
Tested that the window is showing and hiding properly and that the displayed text is showing properly with correct styling.
Impact
The text is loaded in about 0.3ms at the start of the app, so no impact on performance.
Additional Information
My solution doesn't cover all markup styling, only the ones most commonly used in the change log.
I tested the MarkdownLabel addon and it works fine as well, but it was significantly heavier on the performance (50ms vs my 0.3ms) and bring a lot more files with almost the same final effect.
If there is a need to have a full support of markdown style, this addon can be added instead and reused in the Change Log.
Checklist