Adding onboarding doc with excalidraw images - #151
Open
maernest04 wants to merge 1 commit into
Open
Conversation
steeevin88
reviewed
Aug 21, 2026
steeevin88
left a comment
Contributor
There was a problem hiding this comment.
nice addition + definitely helps with ramping up onto SCEvents
only potential gripe I have is updating this doc once the project changes/ new features are added; how can we prevent this some getting stale?
ex. we initially avoided super verbose code pointers in the READ.ME b/c we (rightly) anticipated code changes
ideally updating this doc is just automated but idk what budget would be needed, what do you think
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
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.
PR for #150
Problem
For SCEvents, we have the original development team but we need to add more contributors to help maintain the project as time goes on. Currently, there is no onboarding documentation for SCEvents, making it difficult to add more people.
Solution
Added an onboarding document covering: