-
Notifications
You must be signed in to change notification settings - Fork 209
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
[repo] docs: revamp getting started docs #1127
Conversation
Agreed. We will continue to add docs in the coming weeks. |
|
Linked issues
closes: #733 #1126 #732 (issue number)
Adding: @corinagum, @Carter425 as contributors since I rephrased and relocated docs written by them.
Details
Added the following sections
Tweaked the following sections
Removed the following sections from the existing getting started docs
Attestation Checklist
My code follows the style guidelines of this project
I have checked for/fixed spelling, linting, and other errors
I have commented my code for clarity
I have made corresponding changes to the documentation (we use TypeDoc to document our code)
My changes generate no new warnings
I have added tests that validates my changes, and provides sufficient test coverage. I have tested with:
New and existing unit tests pass locally with my changes