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.

Sign up for GitHub

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

Jump to bottom

Improve help in context menu documentation #4303

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve help in context menu documentation #4303

wants to merge 2 commits into from
+1 −1

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

@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
@@ -185,7 +185,7 @@ When you **right-click on a block**, the following options are available:

![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

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

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".

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

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Ubayed-Bin-Sufian @pikurasa