Update PR template and improve example validator script#686
Open
222448082Ashen wants to merge 3 commits intothoth-tech:mainfrom
Open
Update PR template and improve example validator script#686222448082Ashen wants to merge 3 commits intothoth-tech:mainfrom
222448082Ashen wants to merge 3 commits intothoth-tech:mainfrom
Conversation
Revamps the pull request template for clarity and geometry example validation instructions. Adds single-example validation mode to usage-examples-testing-script.cjs, enabling reliable checks for flat-file usage example layouts.
✅ Deploy Preview for splashkit ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
stelaukin
reviewed
Jan 17, 2026
stelaukin
left a comment
stelaukin
left a comment
There was a problem hiding this comment.
This commit has changed the template for pull requests which would mean if merged other students would not have access to the blank template on the site.
Revised the pull request template for clarity, expanded checklists, and improved instructions. Removed the single-example validation output and related logic from usage-examples-testing-script.cjs to streamline the script and reduce console clutter.
Enhanced the API documentation script to better handle overloaded function links and example references, including correct anchor generation for functions with multiple overloads. Updated usage-example-references.json to add new examples, fix duplicate entries, and adjust titles and formatting for consistency.
stelaukin
approved these changes
Jan 25, 2026
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
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.
Revamps the pull request template for clarity and geometry example validation instructions. Adds single-example validation mode to usage-examples-testing-script.cjs, enabling reliable checks for flat-file usage example layouts.
Description
Please include a summary of the changes and the related issue. Please also include relevant
motivation and context. List any dependencies that are required for this change.
Type of change
Please delete options that are not relevant.
expected)
How Has This Been Tested?
Please describe the tests that you ran to verify your changes. Provide instructions so we can
reproduce. Please also list any relevant details for your test configuration.
Testing Checklist
Checklist
Please delete options that are not relevant.
If involving code
If modified config files
Folders and Files Added/Modified
Please list the folders and files added/modified with this pull request and delete options that are not relevant.
Additional Notes
Please add any additional information that might be useful for the reviewers.