Organize documentation files into Docs/ folder and update links (#3569) #4735
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
✅ All Jest tests passed! This PR is ready to merge. |
|
The help widget uses some of these files. Does it know how to find them now that you have moved things? |
AnshManwani
added a commit
to AnshManwani/musicblocks
that referenced
this pull request
Sep 2, 2025
- Moved all documentation folders (documentation*, guide*, examples, FAQ) to Docs/ - Updated help widget in js/widgets/help.js to reference new Docs/documentation/ paths - Updated HTML and Markdown files with new documentation paths - Cleaned up root directory by removing documentation folders - Verified help widget can access documentation from new location This addresses the help widget concern raised in PR sugarlabs#4735 and completes issue sugarlabs#3569.
|
This pull request has been open for more than 60 days without any activity. It will be closed in 3 days unless the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request improves the project structure by consolidating all documentation files and folders into a single Docs/ directory. It also updates all relevant internal links and references across the project to reflect these new locations.
Changes made:
Moved existing documentation folders (including guides, FAQs, examples, and language-specific documentation) into the new Docs/ directory.
Renamed conflicting README files with more descriptive names within Docs/ to avoid overwriting.
Updated markdown files throughout the repository, adjusting links and references to the new file paths.
Verified that documentation links render correctly after the moves.
No automated tests were run, as the project currently does not specify test scripts in package.json.
This reorganization aims to improve maintainability and ease of navigation for contributors and users.
Closes issue #3569.