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

Alchemy documentation requests #38

Open
dkent600 opened this issue Oct 15, 2019 · 1 comment
Open

Alchemy documentation requests #38

dkent600 opened this issue Oct 15, 2019 · 1 comment
Assignees

Comments

@dkent600
Copy link
Contributor

dkent600 commented Oct 15, 2019

Coding guidelines, how-tos

Interacting directly with Subgraph (1)

  • how to run queries in a browser, with a few basic examples that include filtering records and joining entities - Shivani
  • see a list of entities - Shivani

Using the Client to interact with Subgraph (1)

  • how to run raw graphql queries in a dApp - Shivani
  • how and when to use withSubscription. What is its purpose and appropriate use. - Jelle
  • how to use client API, particularly: - Shivani
    • fetching, state
    • role and basic use of observables
    • subscriptions
    • entities
    • events

Development processes, practices (2)

  • how our genericscheme input forms system works - already exists, Shivani
  • naming convention for the typical component props and state props interfaces - Tibet
  • our standard practices for component architecture, function versus class component, pure components - Tibet
  • best practice for fixing common react component lint errors - Tibet
  • review and update all of the Alchemy repo readme files for accuracy, clarity and completeness - Jelle
  • review all the DAOstack repos for documentation consistency, etc - Shivani
  • what contracts Alchemy (client) is supporting, identify the pages that support each - Shivani
  • describe how Alchemy UI actions map to blockchain contracts, other services - Shivani
  • for Arc contracts, track how they are treated, handled in our stack (Arc => compilation => migration => subgraph => client) - Shivani

APIs (machine-generated) (4)

  • client - Jelle
  • topics that simply redirect to the machine-generated pages

Internal (3)

  • how our sites are deployed - very internal, Jelle
@jellegerbrandy
Copy link

I've created user stories on targetprocess for each of the items that are not shivani's...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants