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

Refactor structure and fix broken links in documentation #4246

Merged
merged 2 commits into from
Jan 13, 2025

Conversation

saumyashahi
Copy link
Contributor

@saumyashahi saumyashahi commented Jan 8, 2025

Summary

Fix issues in the documentation by resolving broken links caused by incorrect Markdown references and reorganizing misplaced text in the toolbar and context menu sections.

Key Changes

  • Correct Markdown syntax for link references to make them valid.
  • Move the context menu text from the toolbar section to its appropriate location in the context menu section.
  • Adjust structure for clarity and accuracy to ensure sections align with their intended topics.
  • Remove redundant content for Context Menu's
  • Add a labelled image for background context menu

Testing

View the rendered documentation to confirm that the changes appear correctly in the desired format.

@saumyashahi
Copy link
Contributor Author

saumyashahi commented Jan 8, 2025

@walterbender @pikurasa, I have addressed the issues and made the necessary changes. Please review the updates and let me know if there are any additional adjustments or improvements needed.

@walterbender
Copy link
Member

This is an improvement. But I think that have the block context described in two different places is a bit confusing and redundant. Maybe consolidate them?

@saumyashahi
Copy link
Contributor Author

Sure!, will consolidate them , I was thinking of adding a few images for the workspace menu too, there are images present only for block menu.

@saumyashahi saumyashahi reopened this Jan 13, 2025
@saumyashahi
Copy link
Contributor Author

I have made the changes and removed redundancy. I also added this labelled image to give a better understanding of background context menu:

Context Menu for Workspace

@walterbender
Copy link
Member

Much much nicer. Thx.

@walterbender walterbender merged commit 884f4bb into sugarlabs:master Jan 13, 2025
@saumyashahi
Copy link
Contributor Author

Thank you, @walterbender sir! I'm glad to have helped.

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.

Inconsistent Heading and Description for "Context Menu" in Music Blocks Documentation
2 participants