commercetools / commercetools/commercetools-project-sync

[Hacktoberfest] Restructure the project documentation.

Open
#333 2 comments 0 reactions 1 assignee Claimed by @carlospatinos View on GitHub
Hacktoberfest
Dominant language
Java
Stars
50
Forks
29
PR merge metrics
No merged PRs in 30d

Description

**Situation**
The usage of the project is documented on the readme file.

**Complication**
With every update the documentation getting bigger and now it's not easy to navigate.

**Resolution**
Improve the documentation of the project with restructuring it.

**Ideas**
A new markdown could be created for the different parts and might be linked in the main readme.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.