Fix:Host the README file content as a set of webpages#6497
Fix:Host the README file content as a set of webpages#6497sapnilbiswas wants to merge 3 commits intosugarlabs:masterfrom
Conversation
github-actions
bot
added
bug fix
|
✅ All Jest tests passed! This PR is ready to merge. |
There was a problem hiding this comment.
Pull request overview
This PR restructures the Music Blocks Guide from a single, heavy page into multiple sectioned HTML pages with a shared sidebar navigation layout.
Changes:
- Added separate HTML pages for guide sections (01–06).
- Introduced a consistent sidebar navigation + simple styling on each page.
- Preserved language switch links across the new pages.
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 17 comments.
Show a summary per file
| File | Description |
|---|---|
| Docs/guide/01-getting-started.html | New “Getting Started” guide page with sidebar + section content |
| Docs/guide/02-making-sounds.html | New “Making Sounds” guide page with sidebar + section content |
| Docs/guide/03-programming-with-music.html | New “Programming with Music” guide page with sidebar + section content |
| Docs/guide/04-widgets.html | New “Widgets” guide page with sidebar + section content |
| Docs/guide/05-beyond-music-blocks.html | New “Beyond Music Blocks” guide page with sidebar + section content |
| Docs/guide/06-appendix.html | New “Appendix” guide page with sidebar + section content |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
@walterbender could you please have a look at ti spr and let me know if there is any further changes required |
|
pls check the comment on the issue and share you opinion. |
farhan-momin
left a comment
farhan-momin
left a comment
There was a problem hiding this comment.
@sapnilbiswas Thankyou for your contribution. Here is my review-
-
Labeling this PR as
Bug Fixis a bit misleading. It is more of aRefactorandFeature. -
The PR is adds a sidebar navigation which can be a good addition to the existing guide hosted at https://sugarlabs.github.io/musicblocks/Docs/guide.
-
The PR is working in Browser testing-
- I have not gone through all the code changes, but i noticed
http://github.com/...links are used at some places instead ofhttps. Its better to use https links for security and consistency.
|
true i also feel the same since the original issue was labeled as bug, I marked the PR as bug i will update it now also thanks @farhan-momin for review it will get the https link updated |
|
✅ All Jest tests passed! This PR is ready to merge. |
# Conflicts: # Docs/guide/index.html
|
✅ All Jest tests passed! This PR is ready to merge. |
Description
Currently, the Music Blocks Guide opens the Docs/guide/README.md content inside a single, heavily loaded HTML file without an optimal browsing structure.
This PR resolves the issue by hosting the contents of the guide as a well-structured set of webpages, natively behaving similarly to the documentation style utilized by Zulip (ReadTheDocs).
PR Category
Changes Included:
Split the documentation Guide: Partitioned the monolithic README.md guide inside the Docs/guide repository into logical separate .html files representing each top-level documentation section (e.g., 01-getting-started.html, 02-making-sounds.html, 03-programming-with-music.html).
Sidebar GUI: Converted Docs/guide/index.html to operate as an introductory landing page that employs a sticky sidebar navigation menu, which connects all newly generated web pages together.
Preserved Existing Linking:
js/turtledefs.js relies on loading /Docs/guide/index.html, which will still correctly navigate users to our new guide ecosystem.
Retained all international language translation links directly inside the new index layout untouched.
Clean Styling Implementation: Applied simple CSS to mirror standard ReadTheDocs aesthetics while staying strictly within the project scope constraints and utilizing the pre-existing Bootstrap version.
Checklist
fixes #6239