The documentation should be separated for users and contributors.
The user docs in GH-Pages and the contributor docs are in a separate MD file.
Reference:
Contributors documentation need to have the next points:
Stack
Local Setup
Workflow
Conventions
Kanban
Milestones
How to publish
The points above we already have and it shows in the NPM that info shouldn't have to be there.
Also, that current points need to be updated.
Definition of done
Review
Publish
Acceptance Criteria
A separated MD file with the points described above, the readme.md file should be updated and the current info at npm should be removed and replaced by the info in the readme.md.
Narrative
The documentation should be separated for users and contributors. The user docs in GH-Pages and the contributor docs are in a separate MD file.
Reference:
Contributors documentation need to have the next points:
The points above we already have and it shows in the NPM that info shouldn't have to be there.
Also, that current points need to be updated.
Definition of done
Acceptance Criteria
A separated MD file with the points described above, the readme.md file should be updated and the current info at npm should be removed and replaced by the info in the readme.md.