Skip to content

Improve help in context menu documentation#4303

Merged
walterbender merged 2 commits intosugarlabs:masterfrom
Ubayed-Bin-Sufian:documentation_enhancement_04
Feb 2, 2025
Merged

Improve help in context menu documentation#4303
walterbender merged 2 commits intosugarlabs:masterfrom
Ubayed-Bin-Sufian:documentation_enhancement_04

Conversation

@Ubayed-Bin-Sufian
Copy link
Contributor

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian commented Jan 24, 2025 •
edited
Loading

Summary:

This PR enhances the documentation of Music Blocks to improve usability, readability, and alignment with the latest version of the platform. It serves as a follow-up to #3945.

Changes introduced:

  • Improve documentation for the help option in the context menu in documentation/README.md.
  • Update the help widget image

Checklist:

  • My changes adhere to the project's contribution guidelines.
  • Tested all live links to ensure they are operational and relevant.
  • Verified that the table of contents is navigable and functional.
  • Ensured that images and diagrams are clear and appropriately labeled.

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian changed the title Documentation enhancement 04 Improved help in context menu documentation Jan 24, 2025
@Ubayed-Bin-Sufian Ubayed-Bin-Sufian changed the title Improved help in context menu documentation Improve help in context menu documentation Jan 24, 2025
@Ubayed-Bin-Sufian Ubayed-Bin-Sufian force-pushed the documentation_enhancement_04 branch from ab64f03 to 1f54dac Compare January 24, 2025 11:42
@Ubayed-Bin-Sufian
Copy link
Contributor Author

Ubayed-Bin-Sufian commented Jan 24, 2025

@walterbender based on the following suggestions in #3945 , I have made the changes. Please have a look.

I am not sure that the text beginning at Line 130 adds any value.
But you may want to mention that many help screens allow you do insert the example blocks into your program by clicking on the download icon (Load this block).

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian marked this pull request as ready for review January 24, 2025 12:01
pikurasa
pikurasa reviewed Jan 24, 2025
View reviewed changes
documentation/README.md Outdated
![Duplicate](./duplicate.png "Duplicate")

**Help**: The Help option displays a detailed help screen for the selected block. This screen provides valuable information about the block’s functionality, purpose, and usage instructions, making it easier for users to understand and effectively incorporate the block into their projects.
**Help**: The Help option displays a detailed help screen for the selected block. This screen provides valuable information about the block’s functionality, purpose, and usage instructions, making it easier for users to understand and effectively incorporate the block into their projects. By using the right-click context menu in Music Blocks, you can quickly perform common tasks and manipulate blocks on the workspace. This can help you to work more efficiently and effectively in your projects. Additionally, help screens allow you to insert example blocks directly into your program by clicking on the download icon *(labeled Load this block)*.
Copy link
Collaborator

@pikurasa pikurasa Jan 24, 2025

Choose a reason for hiding this comment

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

This can help you work more efficiently and effectively in building your projects. Additionally, the help screen allows you to insert blocks from the help examples directly into your program by clicking on the download icon (labeled "Load this Block").

Copy link
Collaborator

@pikurasa pikurasa Jan 24, 2025

Choose a reason for hiding this comment

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

or maybe (labeled "Load this Block" in the image below).

Also, I don't think we need italics there, especially not for "labeled".

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian force-pushed the documentation_enhancement_04 branch 3 times, most recently from 7cceac6 to 519fb66 Compare January 26, 2025 10:24
@Ubayed-Bin-Sufian
Copy link
Contributor Author

Ubayed-Bin-Sufian commented Jan 26, 2025

@pikurasa I have changed the file as needed. Please review.

@walterbender
Copy link
Member

walterbender commented Jan 26, 2025

Sorry to be joining the discussion late, but while I think it is great to mention that from block help you can load example code into your project, I don't understand the call out to the right-click menu. Seems out of place.

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian force-pushed the documentation_enhancement_04 branch from 4d79e41 to 080576b Compare January 26, 2025 16:39
@Ubayed-Bin-Sufian
Copy link
Contributor Author

Ubayed-Bin-Sufian commented Jan 26, 2025

@walterbender Changed the code based on the review:

Sorry to be joining the discussion late, but while I think it is great to mention that from block help you can load example code into your project, I don't understand the call out to the right-click menu. Seems out of place.

@walterbender
Copy link
Member

walterbender commented Jan 26, 2025

Maybe the example should be one that is more extensive, like this:
Screenshot From 2025-01-26 14-02-24

@Ubayed-Bin-Sufian
Copy link
Contributor Author

Ubayed-Bin-Sufian commented Jan 27, 2025

Maybe the example should be one that is more extensive, like this: Screenshot From 2025-01-26 14-02-24

@walterbender I have added the image. Please review.

@pikurasa
Copy link
Collaborator

pikurasa commented Jan 30, 2025

I liked "load this block" with the arrow that you had in 080576b

Perhaps add that back?

@walterbender
Copy link
Member

walterbender commented Jan 30, 2025

Screenshot From 2025-01-30 04-51-58

This version includes the hover help for the download button.

@Ubayed-Bin-Sufian Ubayed-Bin-Sufian force-pushed the documentation_enhancement_04 branch from 45645b9 to e003a1d Compare February 2, 2025 21:10
@Ubayed-Bin-Sufian
Copy link
Contributor Author

Ubayed-Bin-Sufian commented Feb 2, 2025

Screenshot From 2025-01-30 04-51-58

This version includes the hover help for the download button.

@walterbender I have added the suggested image. Please review.

@walterbender walterbender merged commit 8818d6c into sugarlabs:master Feb 2, 2025
4 checks passed
@Ubayed-Bin-Sufian Ubayed-Bin-Sufian deleted the documentation_enhancement_04 branch February 12, 2025 15:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pikurasa pikurasa pikurasa left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Ubayed-Bin-Sufian @walterbender @pikurasa