Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

[DOCS] Improve Documentation #35

Open
2 of 4 tasks
ish-u opened this issue Jul 11, 2022 · 2 comments
Open
2 of 4 tasks

[DOCS] Improve Documentation #35

ish-u opened this issue Jul 11, 2022 · 2 comments
Assignees
@ish-u
Labels
documentation Improvements or additions to documentation

Comments

@ish-u
Copy link
Contributor

ish-u commented Jul 11, 2022 •
edited by amandamartin-dev
Loading

Description

  • Add a description about the Project , how it works and how somebody can use it
  • Add Demo Images/GIFs , Link to Live Demo
  • Add Contirbution Guide -> Steps to setup Local Development , Steps to Create a PR , Contribution Guidelines
  • Add Mock Data for Development - I don't quite understand how GitHub Actions works (some web socket events ig) but I guess it would be better to have some Mock Data while developing the FrontEnd.
@ish-u ish-u added the documentation Improvements or additions to documentation label Jul 11, 2022
@Onyelaudochukwuka Onyelaudochukwuka mentioned this issue Jul 11, 2022
Merged
6 tasks
@amandamartin-dev amandamartin-dev self-assigned this Dec 11, 2022
@amandamartin-dev amandamartin-dev mentioned this issue Dec 11, 2022
Merged
6 tasks
@amandamartin-dev amandamartin-dev removed their assignment Dec 13, 2022
@vedant-z
Copy link

@ish-u May I take the 2nd sub-issue? Adding Demo images...

@amandamartin-dev
Copy link
Contributor

Sure, assigned!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@ish-u ish-u

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@ish-u @vedant-z @amandamartin-dev