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

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

@navneet15

Description

@navneet15

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

Metadata

Metadata

Labels

documentationThe issues related to docs & wiki of the projectenhancementNew feature or requestgood first issueGood for newcomers

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions