docs: improve README with modern structure and navigation#35
Conversation
66-m
commented
Mar 11, 2026
66-m
commented
- Added table of contents for quick navigation
- Reorganized features with collapsible 2D/3D visualization sections
- Enhanced visual hierarchy with horizontal rules and better spacing
- Improved code block formatting and requirements presentation
- Added GitHub release badge
- Consolidated hero section with badges at top
- Grouped algorithms into a compact table format
- Added table of contents for quick navigation - Reorganized features with collapsible 2D/3D visualization sections - Enhanced visual hierarchy with horizontal rules and better spacing - Improved code block formatting and requirements presentation - Added GitHub release badge - Consolidated hero section with badges at top - Grouped algorithms into a compact table format
There was a problem hiding this comment.
Pull request overview
Updates repository documentation and contributor tooling to make the project easier to navigate and to standardize local commit workflow guidance.
Changes:
- Modernizes
README.mdstructure with a centered hero section, release badge, TOC, and reorganized feature lists. - Adds a GitHub prompt file to guide creating branches and committing changes using Conventional Commits.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| README.md | Restructures project documentation with navigation, clearer setup/build steps, and reorganized features/visualizations. |
| .github/prompts/commit.prompt.md | Adds an agent prompt describing a standardized branch + commit workflow and push advice. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
| - Hoops | ||
| - Morphing Shell | ||
| - Mosaic Squares | ||
|
|
||
| </details> | ||
|
|
||
| <details> | ||
| <summary>3D Visualizations (10)</summary> | ||
|
|
There was a problem hiding this comment.
The Visualizations section classifies “Morphing Shell” under 2D, but in the codebase MorphingShell is labeled as a 3D visualization (its name is "3D - Morphing Shell"). Please move it to the 3D list so the 2D/3D grouping matches what the app shows (and so the 3D list actually contains 10 items).
| </div> | ||
| <br /> | ||
| This sorting visualizer offers both visual and auditory demonstrations of sorting algorithms. It features 22 different sorting methods represented through a collection of 30 visuals, including a selection of 3D models. A settings menu is included to enable users to adjust the appearance and functionality of the visualizer. | ||
| <p>Visualize and audiolize sorting algorithms in real time — with 22 algorithms, 30 visualizations, and full 3D support.</p> |
There was a problem hiding this comment.
“audiolize” is not standard spelling in English and reads like a typo in the project tagline. Consider replacing it with a more common verb (e.g., “sonify” / “add audio to”) to improve readability/searchability.
| <p>Visualize and audiolize sorting algorithms in real time — with 22 algorithms, 30 visualizations, and full 3D support.</p> | |
| <p>Visualize and add audio to sorting algorithms in real time — with 22 algorithms, 30 visualizations, and full 3D support.</p> |
