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

Update README.md #28

Open
5 tasks
hobbescodes opened this issue Jun 24, 2024 · 0 comments
Open
5 tasks

Update README.md #28

hobbescodes opened this issue Jun 24, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hobbescodes
Copy link
Owner

Description

There are a lot of different workflows that this template offers. Would like to update the README.md (or better yet set up a docs website with vocs) to describe and offer direction on different workflows:

  • What to update when changing the packages/contracts structure
  • What to update / do when adding new components to packages/ui
  • Setting up an appropriate anvil network on popular browser wallets when applicable
  • Updating apps/ponder to use a REST api rather than the default configuration (which uses GraphQL)
  • Appropriate workflows for testing packages and/or apps in isolation when applicable

These are just a few of the different workflows that could / should be described. The ultimate goal of this starter kit is to provide not only a great scaffolding that uses cutting edge software, but also provides guidance for those that may have limited experience with certain pieces of software that this monorepo relies on.

There are many angles to consider here, so I am very much open to discussion and will keep this issue open as more workflows and ideas come about!

@hobbescodes hobbescodes added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed and removed enhancement New feature or request help wanted Extra attention is needed labels Jun 24, 2024
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
Projects
None yet
Development

No branches or pull requests

1 participant