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

Add documentation for Coinbase SDK integration #1727

Open
monilpat opened this issue Jan 3, 2025 · 1 comment
Open

Add documentation for Coinbase SDK integration #1727

monilpat opened this issue Jan 3, 2025 · 1 comment
Labels
agent-generated For agent creation actions on pull requests, issues, and eventually milestones, releases etc. documentation Improvements or additions to documentation enhancement New feature or request

Comments

@monilpat
Copy link
Collaborator

monilpat commented Jan 3, 2025

Feature Request

Is your feature request related to a problem? Please describe.

The integration of the Coinbase SDK lacks comprehensive documentation, making it challenging for developers to utilize its features effectively.

Describe the solution you'd like

Create detailed documentation for the Coinbase SDK integration, including installation instructions, usage examples, and API reference. This documentation should cover key functionalities such as handling transactions, querying account balances, and managing orders.

Code Example

import { RESTClient } from '@coinbase/coinbase-sdk';

const client = new RESTClient(process.env.COINBASE_API_KEY, process.env.COINBASE_PRIVATE_KEY);

async function getAccount() {
    try {
        const accounts = await client.listAccounts();
        console.log(accounts);
    } catch (error) {
        console.error('Error fetching accounts:', error);
    }
}

Describe alternatives you've considered

Currently, developers rely on trial and error or external resources for guidance, which can lead to confusion and inefficiency.

Additional context

Providing thorough documentation will enhance the developer experience, reduce onboarding time, and improve the overall effectiveness of the SDK integration.

Related Issues/PRs

@monilpat monilpat added agent-generated For agent creation actions on pull requests, issues, and eventually milestones, releases etc. documentation Improvements or additions to documentation enhancement New feature or request labels Jan 3, 2025
@vishal-kanna
Copy link
Contributor

@monilpat I would like to work on it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
agent-generated For agent creation actions on pull requests, issues, and eventually milestones, releases etc. documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants