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

Improve documentation for context menus, macros, register, and panning blocks (#2403) #4231

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

JAK0707
Copy link

@JAK0707 JAK0707 commented Jan 6, 2025

Improve documentation for context menus, macros, register, and panning blocks (#2403)

Summary

This PR adds detailed documentation for context menus, macros, register, and panning blocks in the Guide.

Changes Introduced

  • Context Menus: Added explanation on how to use context menus for block actions.
  • Improved Help Strings: Enhanced descriptions and tooltips for better user understanding.
  • Macros: Documented the process of creating and using macros for automation.
  • Register Block: Explained how it modifies the octave of following notes.
  • Panning Block: Added details on controlling stereo sound positioning.

Why This Is Needed

@walterbender
Copy link
Member

I am a bit confused. Most of this content is nicely written, but does it belong in the Guide, which is essentially a mash up of MB and Music Theory. Maybe repurpose this text for documentation/README.md?

@JAK0707
Copy link
Author

JAK0707 commented Jan 9, 2025

Thank you for the feedback! I appreciate the clarification. Would you prefer that I move this documentation to documentation/README.md instead? I'll be happy to make the necessary changes.

@walterbender
Copy link
Member

Yes. I think the general interface documentation belongs in documentation/README.md

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.

2 participants