Help me make some docs
I have been working on this project for quite a while so most of it makes total sense to me. I need someone who doesn't have my level of context with the codebase to look through it and tell me where we can add some docs and comments to help out new people coming into the codebase.
What to do
look through the code and add DOCME comments anywhere you feel more clarification is needed.
For example
//DOCME what does this function do?
function randomFunc(){
console.log("I'm super confusing")
}
Please be sure to specifically put "DOCME" to start your comment so I can easily search the whole code base for your comments.
Note
I would prefer the questions be about how the code base specifically works not about how React or any of the other libraries in the code base work.
Help me make some docs
I have been working on this project for quite a while so most of it makes total sense to me. I need someone who doesn't have my level of context with the codebase to look through it and tell me where we can add some docs and comments to help out new people coming into the codebase.
What to do
look through the code and add DOCME comments anywhere you feel more clarification is needed.
For example
Please be sure to specifically put "DOCME" to start your comment so I can easily search the whole code base for your comments.
Note
I would prefer the questions be about how the code base specifically works not about how React or any of the other libraries in the code base work.