Skip to content

Update README.md #28

@hobbescodes

Description

@hobbescodes

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!

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions