node-api-template icon indicating copy to clipboard operation
node-api-template copied to clipboard

Create Wiki for a detailed code explanation of the project

Open navneet15 opened this issue 6 years ago • 3 comments

The project has a detailed readme and that's great but my concern is that when the project grows and the code base increases managing readme would be a bit hectic task as to my knowledge read me should only contain project setup guidelines for an end user and developer setup guidelines. So I suggest we can create a proper wiki[0] with a detailed explanation of the project, code structure, and contribution guidelines. That would be more manageable and would help people who would want to pick up contributions later when the code base becomes huge.

Plus good documentation always helps :smile:

[0]https://github.com/knaxus/node-api-template/wiki

navneet15 avatar Mar 24 '19 08:03 navneet15

I can take this issue up of starting an initial documentation of the wiki.

navneet15 avatar Mar 24 '19 08:03 navneet15

@navneet15 thanks for the feedback and it would be really great if you can take up this task along with @TheJSGirl and me.

ashokdey avatar Mar 24 '19 16:03 ashokdey

So @navneet15, @TheJSGirl will be reviewing and correcting things since she was the one who was initially involved with this (I forgot to mention this in the README). I will have a final look once everything is done.

Again, thanks to all of you

ashokdey avatar Mar 24 '19 16:03 ashokdey