coinbase / coinbase/onchainkit

Documentation Request: Clarify required setup steps for OnchainKitProvider in README

Open
#2,563 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
1k
Forks
520
Avg merge
32m
Merged PRs (30d)
2

Description

### Is your documentation request related to a problem? Please describe.

When following the current README to set up `OnchainKitProvider`, it is not always clear which configuration fields are required versus optional. As a result, developers may omit critical values (such as an API key or network configuration) and encounter confusing runtime errors that do not clearly point back to missing setup steps.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by reviewing the README section that explains OnchainKitProvider setup and identify each configuration field described there. Update the documentation to distinguish required from optional values, including the API key and network configuration, then verify that the setup instructions clearly explain what must be provided.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.