daostack / daostack/DAOstack-Hackers-Kit

Alchemy documentation requests

Open
#38 1 comment 0 reactions 1 assignee Claimed by @shivgupt View on GitHub
Dominant language
TypeScript
Stars
202
Forks
81
PR merge metrics
No merged PRs in 30d

Description

# 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](https://daostack.github.io/DAOstack-Hackers-Kit/gettingStarted/setupGenericScheme/#how-to-get-your-generic-scheme-showing-up-in-alchemy), 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.