Skip to content

Reorganise geometry usage#755

Open
anandika-nair wants to merge 189 commits into
thoth-tech:usage-examplesfrom
anandika-nair:reorganise-geometry-usage
Open

Reorganise geometry usage#755
anandika-nair wants to merge 189 commits into
thoth-tech:usage-examplesfrom
anandika-nair:reorganise-geometry-usage

Conversation

@anandika-nair
Copy link
Copy Markdown

Grouped related usage example files into individual folders for better organisation and readability.

Each example now contains its associated files (cpp, cs, py, png, txt) within its own folder.

Tested and confirmed that the website functionality remains unaffected.

anandika-nair and others added 30 commits March 19, 2026 20:30
…o public/usage-examples/geometry/center_point/center_point-1-example-oop.cs
…l.cs to public/usage-examples/geometry/center_point/center_point-1-example-top-level.cs
…ublic/usage-examples/geometry/center_point/center_point-1-example.cpp
…ublic/usage-examples/geometry/center_point/center_point-1-example.png
…blic/usage-examples/geometry/center_point/center_point-1-example.py
…ublic/usage-examples/geometry/center_point/center_point-1-example.txt
…op-level.cs to public/usage-examples/geometry/stars_in_the_sky/random_screen_point-1-example-top-level.cs
…pp to public/usage-examples/geometry/stars_in_the_sky/random_screen_point-1-example.cpp
…ng to public/usage-examples/geometry/stars_in_the_sky/random_screen_point-1-example.png
…y to public/usage-examples/geometry/stars_in_the_sky/random_screen_point-1-example.py
…xt to public/usage-examples/geometry/random_portals/random_window_point-1-example.txt
…op.cs to public/usage-examples/geometry/random_portals/random_window_point-1-example-oop.cs
…op-level.cs to public/usage-examples/geometry/random_portals/random_window_point-1-example-top-level.cs
…pp to public/usage-examples/geometry/random_portals/random_window_point-1-example.cpp
…ng to public/usage-examples/geometry/random_portals/random_window_point-1-example.png
…y to public/usage-examples/geometry/random_portals/random_window_point-1-example.py
….zip to public/usage-examples/geometry/random_portals/random_window_point-1-resources.zip
…-example.txt to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example.txt
…-example-oop.cs to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example-oop.cs
…-example.cpp to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example.cpp
…-example.cs to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example.cs
…-example.png to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example.png
…-example.py to public/usage-examples/geometry/ray_circle_intersect/ray_circle_intersect_distance-1-example.py
…lic/usage-examples/geometry/game_2dpoint/same_point-1-example.txt
…public/usage-examples/geometry/game_2dpoint/same_point-1-example-oop.cs
…cs to public/usage-examples/geometry/game_2dpoint/same_point-1-example-top-level.cs
…lic/usage-examples/geometry/game_2dpoint/same_point-1-example.cpp
…lic/usage-examples/geometry/game_2dpoint/same_point-1-example.png
…ic/usage-examples/geometry/game_2dpoint/same_point-1-example.py
…-example.txt to public/usage-examples/geometry/point_point_angle-1-example.txt
@netlify
Copy link
Copy Markdown

netlify Bot commented May 4, 2026

Deploy Preview for splashkit failed.

Name Link
🔨 Latest commit 3d6cfee
🔍 Latest deploy log https://app.netlify.com/projects/splashkit/deploys/69f8512ea247210008bc97f0

@Osaid2993
Copy link
Copy Markdown

This looks like a very large repo structure change. Because it affects a lot of files and folders at once, I think it needs very careful review and probably mentor confirmation before approval.

Copy link
Copy Markdown

@222448082Ashen 222448082Ashen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Description

This PR performs a large-scale reorganization of the geometry usage examples, grouping related files into logical subfolders. It also transitions the documentation build process to a dynamic directory scanner, removing the need for the manual JSON registry. Additionally, a new buoyancy simulation example has been added to the physics category.

Type of change

  • New feature (Boat buoyancy example)
  • Breaking change (Structural reorganization and infrastructure refactor)
  • Documentation (Pathing and organization updates)

How Has This Been Tested?

  • Manual verification of folder structure.
  • Logic review of scripts/api-pages-script.cjs.
  • Awaiting Fix: Identified a pathing bug where nested subfolders are not correctly resolved by the import script.

Checklist

If involving code

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have made corresponding changes to the documentation

If involving Usage Examples

  • Example is registered (via new dynamic scanner)
  • Title in .txt file is a single line
  • Includes examples for C++, C# (Top-level & OOP), and Python
  • Image (.png) or GIF (.gif) output is included
  • Files are organized into a subfolder (e.g., public/usage-examples/geometry/mouse_click_location/)

If involving structural / repo-wide changes

  • Large-scale change: This PR moves dozens of files and replaces the legacy scraping system.
  • Verified Pathing: IN PROGRESS (Fixing path resolution in api-pages-script.cjs).
  • Mentor Confirmation: Required before merging due to the scale of the structural changes.

Copy link
Copy Markdown

@himanshigaba22 himanshigaba22 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a solid idea, but there is quite a bit to sort out before it can merge. The deploy is failing due to a known pathing issue with nested subfolders not resolving correctly in the import script, so that should be the priority fix. There are also branch conflicts that need to be resolved.

A few specific issues I noticed: closest_point_on_circle-1-example.txt has 2 lines when it should be title only, the ray_circle_intersect folder has a .cs file instead of the required -top-level.cs naming, and the point_point_distance files seem to be scattered across inconsistent folders during the reorganisation.

Since this PR touches 187 files and replaces the JSON registry entirely, I think mentor confirmation is needed before this goes near a merge. The boat_buoyancy example is a nice addition, and the folder structure idea is good overall - it just needs the pathing and naming issues cleaned up first.

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.

4 participants