Skip to content
This repository has been archived by the owner on Feb 20, 2023. It is now read-only.

Update documentation and description for playground #108

Open
maptuhec opened this issue Apr 25, 2019 · 2 comments
Open

Update documentation and description for playground #108

maptuhec opened this issue Apr 25, 2019 · 2 comments
Assignees
Labels
enhancement New feature or request playground
Milestone

Comments

@maptuhec
Copy link
Contributor

I think that if we want to deploy the playground on production we should rework the Readme documentation and the description of the project with more relevant info for the users.

@maptuhec maptuhec added enhancement New feature or request playground labels Apr 25, 2019
@maptuhec maptuhec added this to the Sprint 39 milestone Apr 25, 2019
@sadiqevani
Copy link
Contributor

@maptuhec Can you please propose how do you think these changes will look like/should look like?

@maptuhec
Copy link
Contributor Author

@sadiqevani In my opinion, at least compared to other tools that I have used we should have the following:

  • Brief description of the project (what is the playground, what is used for etc.)
  • If there are any requirements for the project
  • Description of the current functionalities (editor, configs)
  • Some examples and how to use the application

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request playground
Projects
None yet
Development

No branches or pull requests

2 participants