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

fixed readme.md present in documentation #4253

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

Conversation

JAK0707
Copy link

@JAK0707 JAK0707 commented Jan 10, 2025

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

Summary

This PR improves the documentation for context menus, macros, register, and panning blocks. Initially, these changes were added to the Guide, but based on feedback, they have now been moved to documentation/README.md, which is a more appropriate location for technical documentation.

Changes Introduced

  • Moved documentation from the Guide to documentation/README.md as per mentor feedback.
  • 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

Testing Steps

  1. Review the updated documentation/README.md file for clarity.
  2. Verify that the documentation correctly explains each feature.
  3. Ensure all descriptions align with existing UI elements and functionalities.

Related Issue

Closes #2403.

@JAK0707
Copy link
Author

JAK0707 commented Jan 10, 2025

Hi @walterbender,

I've updated the PR based on your feedback and moved the documentation from the Guide to documentation/README.md as suggested. Let me know if this placement works or if any further adjustments are needed.

Thank you for your guidance!

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.

1 participant