Menubar and welcome window

pemba1s1 commented 2 days ago

Screenshots

Summary by Sourcery

Add a menu bar with Settings and Help options to the main window and introduce a welcome message feature. Enhance the settings window with a general settings tab and improve UI by rendering markdown content in help and welcome messages. Update documentation with new markdown files for welcome and about sections.

New Features:

Introduce a menu bar with Settings and Help options in the main window.
Add a welcome message that displays upon application launch, configurable via settings.

Enhancements:

Refactor settings window to include a general settings tab.
Improve the UI by adding HTML rendering for markdown content in help and welcome messages.

Documentation:

Add a welcome markdown file to introduce the AI Medical Scribe project and its features.
Include an about markdown file to provide information on the AI-Scribe project.

sourcery-ai[bot] commented 2 days ago

Reviewer's Guide by Sourcery

This PR implements a menubar and welcome window functionality in the FreeScribe client application. The changes introduce a new menu system with Settings and Help options, along with a welcome message feature that can be toggled through settings. The implementation uses Tkinter for the UI components and includes markdown rendering capabilities for displaying formatted content in the welcome and about windows.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Added menubar with Settings and Help options	Created a new menu bar with Settings and Help menus Moved settings button from main window to menu bar Added About option in Help menu Implemented markdown content display for help windows	`src/FreeScribe.client/UI/MainWindowUI.py` `src/FreeScribe.client/client.py`
Implemented welcome message functionality	Added welcome message display on application startup Created welcome message content in markdown format Added option to disable welcome message through checkbox Implemented settings persistence for welcome message preference	`src/FreeScribe.client/UI/MainWindowUI.py` `src/FreeScribe.client/markdown/welcome.md` `src/FreeScribe.client/markdown/help/about.md`
Restructured settings management	Added general settings tab in settings window Integrated welcome message toggle in settings Moved settings window initialization to MainWindowUI Updated settings storage and loading mechanism	`src/FreeScribe.client/UI/SettingsWindowUI.py` `src/FreeScribe.client/UI/SettingsWindow.py`

Tips and commands

#### Interacting with Sourcery - **Trigger a new review:** Comment `@sourcery-ai review` on the pull request. - **Continue discussions:** Reply directly to Sourcery's review comments. - **Generate a GitHub issue from a review comment:** Ask Sourcery to create an issue from a review comment by replying to it. - **Generate a pull request title:** Write `@sourcery-ai` anywhere in the pull request title to generate a title at any time. - **Generate a pull request summary:** Write `@sourcery-ai summary` anywhere in the pull request body to generate a PR summary at any time. You can also use this command to specify where the summary should be inserted. #### Customizing Your Experience Access your [dashboard](https://app.sourcery.ai) to: - Enable or disable review features such as the Sourcery-generated pull request summary, the reviewer's guide, and others. - Change the review language. - Add, remove or edit custom review instructions. - Adjust other review settings. #### Getting Help - [Contact our support team](mailto:support@sourcery.ai) for questions or feedback. - Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information. - Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

socket-security[bot] commented 2 days ago

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
pypi/markdown@3.7	environment, eval, filesystem Transitive: network, shell, unsafe	`+131`	172 MB	facelessuser, qaramazov, waylan
pypi/tkhtmlview@0.3.1	filesystem, network	`0`	42.3 kB	bauripalash

View full report↗︎

pemba1s1 commented 2 days ago

@yingbull I have already made all the changes requested by the bot earlier. Forgot to comment it.

ClinicianFOCUS / FreeScribe