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

[DOCS] improve documentation of Sharkfolio #39

Closed
RakeshSangem opened this issue Oct 9, 2022 · 2 comments · Fixed by #41
Closed

[DOCS] improve documentation of Sharkfolio #39

RakeshSangem opened this issue Oct 9, 2022 · 2 comments · Fixed by #41
Assignees
@stevenjburrows
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest hacktoberfest2022

Comments

@RakeshSangem
Copy link
Owner

The current documentation is not user friendly.

It does not provide enough information about the project.

We need to make sure that our users have the information they need in order to use our project correctly.

  • Improve the flow of documentation
  • Add license, contributing etc. info.
@RakeshSangem RakeshSangem added documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest hacktoberfest2022 labels Oct 9, 2022
@stevenjburrows
Copy link
Contributor

I can add the contributing.md if you want

@RakeshSangem
Copy link
Owner Author

I can add the contributing.md if you want

Assigned👍

@zelfroster zelfroster mentioned this issue Oct 10, 2022
Merged
@stevenjburrows stevenjburrows mentioned this issue Oct 10, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stevenjburrows stevenjburrows

Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest hacktoberfest2022
Projects
SharkFolio
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

DOCS: updated README zelfroster/Sharkfolio
2 participants
@stevenjburrows @RakeshSangem