Skip to content

Adding onboarding doc with excalidraw images - #151

Open
maernest04 wants to merge 1 commit into
mainfrom
ernest_ma/adding_onboarding_doc
Open

Adding onboarding doc with excalidraw images#151
maernest04 wants to merge 1 commit into
mainfrom
ernest_ma/adding_onboarding_doc

Conversation

@maernest04

Copy link
Copy Markdown
Collaborator

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:

  • Project architecture and dependencies
  • Local setup and testing
  • Domain concepts and registration flow
  • API and Clark integration
  • Debugging and recovery guidance
  • Development and deployment workflows

@steeevin88 steeevin88 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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

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.

2 participants