thinktandem / tandem

All the things that power the Tandem engine
https://thinktandem.io/
4 stars 2 forks source link

Improve onboarding and wrap up docs #87

Open pirog opened 5 years ago

pirog commented 5 years ago

What is to be done?

I've done a first pass on porting, reorganizing and consolidating our old onboarding-ish docs into a new "handbook" https://tandem-docs.lndo.site/handbook/

However, i am guessing there are some things that may no longer be relevant and some things that may be missing.

@serundeputy i'd like you to focus in particular on https://tandem-docs.lndo.site/handbook/onboarding.html https://tandem-docs.lndo.site/handbook/wrap.html

In particular, pretend you are a new developer being onboarded and ask "does this onboarding checklist and wrap up taskz" get me in a position to hit the ground running eg is there anything you use in you day-to-day as a developer that is grossly omitted from here? Feel free to make other suggestions for improvement as well. Do not drop the suggestions here. Just spin up a PR right away and we can do the review that way. Also do not worry abut catching everything because @reynoldsalec will also be doing a pass when you are done.

@reynoldsalec i'd like for you to review said PR when it's up with an eye for the same things.

Task checklist