Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Hacktoberfest] Restructure the project documentation. #333

Open
ahmetoz opened this issue Sep 24, 2021 · 2 comments · May be fixed by #340
Open

[Hacktoberfest] Restructure the project documentation. #333

ahmetoz opened this issue Sep 24, 2021 · 2 comments · May be fixed by #340
Assignees
@carlospatinos
Labels
Hacktoberfest

Comments

@ahmetoz
Copy link
Contributor

ahmetoz commented Sep 24, 2021

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.
@carlospatinos
Copy link

May I take this ?

@ahmetoz
Copy link
Contributor Author

ahmetoz commented Oct 1, 2021

@carlospatinos yes, feel free to contribute 💯

carlospatinos added a commit to carlospatinos/commercetools-project-sync that referenced this issue Oct 1, 2021
@carlospatinos
fix commercetools#333 Lets see if this is what you were looking for
130c67a
@carlospatinos carlospatinos linked a pull request Oct 1, 2021 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@carlospatinos carlospatinos

Labels
Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix #333 Lets see if this is what you were looking for carlospatinos/commercetools-project-sync
2 participants
@ahmetoz @carlospatinos