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.

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

README update required #23

Open
4 tasks
AltiMario opened this issue Apr 26, 2023 · 3 comments
Open
4 tasks

README update required #23

AltiMario opened this issue Apr 26, 2023 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@AltiMario
Copy link

  • Project description expansion
    "The project provides a template to kickstart dapp development on Cardano" is not enough for the user.

  • Expand it by writing what the common problems solved by this project in dapp development on Cardano, to ensure users have the right expectation on what to find here.

  • What are the goals for the user adopting this project?

  • Why should other developers care about maintaining this repo? (could be just Mlabs devs or the opensource community)

  • Add a "Get Started" section

  • Developers who want to use it for testing/curiosity purposes need simple steps to follow.

  • Add a "Project history" section

  • Describe why was necessary to create (not even by forking) the new "the-plutus-scaffold" instead of just evolving the previous "plutus-scaffold" project.

  • Highlight the problems there and the necessities here and the lessons learned from this action.

  • Expand the Fronted section

  • Add 2 screenshots about the 2 use cases addressed. It is always good to have visual feedback on how it will look.

@AltiMario AltiMario added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 26, 2023
@zmrocze
Copy link
Contributor

zmrocze commented May 2, 2023

Add 2 screenshots about the 2 use cases addressed. It is always good to have visual feedback on how it will look.

This might be redundant if we can provide a link to the website instead of screenshots of the website

@AltiMario
Copy link
Author

yes potentially, however, there is no working link yet, no clarity on where/when it will be deployed, adding 2 screenshots is not a big deal anyway (can be updated or removed) in case of redundancy

@zmrocze
Copy link
Contributor

zmrocze commented May 5, 2023

I expanded on the sections I could and will pr the change once I can add the section "Getting started" (blocked by #25)

This was referenced May 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants