-
Notifications
You must be signed in to change notification settings - Fork 69
feat(usage-examples): add three basic usage examples #678
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
base: main
Are you sure you want to change the base?
Conversation
❌ Deploy Preview for splashkit failed.
|
|
Hi team, the Netlify deploy failed due to missing DocSearch environment variables. |
General Information
Code Quality
Functionality
Testing
Documentation
Pull Request Details
Required Changes Before ApprovalCritical: This PR does not follow the established usage example contribution guidelines. Please refer to CONTRIBUTING.mdx and restructure as follows: For each example, create these files:Basic Drawing Example (demonstrating Mouse Position Example (demonstrating Sprite Example (demonstrating Remove:
|
|
Thanks for the detailed review. I’m restructuring the three examples to the required multi-file format (cpp/cs/py/txt/png + resources zip) as per CONTRIBUTING.mdx. I’ll push updates shortly. |
|
Update Based on Reviewer Feedback I have updated the pull request to follow the full SplashKit usage-example contribution guidelines. Changes Completed
Deleted: 01-basic-drawing.mdx 01-mouse-position.mdx 01-basic-sprite.mdx
Each example now includes all required variants: Basic Drawing (fill_circle) fill_circle-01-example.txt fill_circle-01-example.cpp fill_circle-01-example-oop.cs fill_circle-01-example-top-level.cs fill_circle-01-example.py fill_circle-01-example.png Mouse Position (mouse_x) mouse_x-01-example.txt mouse_x-01-example.cpp mouse_x-01-example-oop.cs mouse_x-01-example-top-level.cs mouse_x-01-example.py mouse_x-01-example.png Sprite (create_sprite) create_sprite-01-example.txt create_sprite-01-example.cpp create_sprite-01-example-oop.cs create_sprite-01-example-top-level.cs create_sprite-01-example.py create_sprite-01-example.png create_sprite-01-example-resources.zip (contains Resources/player.png)
File structure matches CONTRIBUTING.mdx. Examples load correctly in the local Starlight dev environment. No remaining autogenerated file modifications. Ready for Review Please let me know if you’d like any formatting or naming adjustments. |
|
Added a new key_down input usage example following the required naming and multi-file structure (.txt, .cpp, C# OOP, C# top-level, .py, .png). |
|
To help contributors understand the necessary usage-example format, a brief checklist and filename example have been added to public/usage-examples/CONTRIBUTING.mdx. |
Added three new usage examples to support beginner learning:
• graphics/01-basic-drawing.mdx
• input/01-mouse-position.mdx
• sprites/01-basic-sprite.mdx
Each file follows the SplashKit Usage Example Style Guide:
Testing
astro dev(DocSearch disabled locally)npm run buildRequesting feedback and approval.