Skip to content
This repository has been archived by the owner on Jun 19, 2020. It is now read-only.

Create Wiki for a detailed code explanation of the project #2

Open
navneet15 opened this issue Mar 24, 2019 · 3 comments
Open

Create Wiki for a detailed code explanation of the project #2

navneet15 opened this issue Mar 24, 2019 · 3 comments
Assignees
Labels
documentation The issues related to docs & wiki of the project enhancement New feature or request good first issue Good for newcomers

Comments

@navneet15
Copy link

navneet15 commented Mar 24, 2019

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 😄

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

@navneet15
Copy link
Author

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

@ashokdey
Copy link
Member

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

@ashokdey ashokdey added documentation The issues related to docs & wiki of the project enhancement New feature or request labels Mar 24, 2019
@ashokdey
Copy link
Member

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 ashokdey added the good first issue Good for newcomers label May 6, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation The issues related to docs & wiki of the project enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants