Skip to content

Fix Go example link in CDP SDK docs#595

Open
0x4tl4nt wants to merge 1 commit intocoinbase:mainfrom
0x4tl4nt:examples-branch
Open

Fix Go example link in CDP SDK docs#595
0x4tl4nt wants to merge 1 commit intocoinbase:mainfrom
0x4tl4nt:examples-branch

Conversation

@0x4tl4nt
Copy link

Description

The docs previously referenced a non-existent file example.go for a full end-to-end example of using the CDP SDK:
image
I tried to find it in other dirs, assuming that the file existed.
The previous link can be confusing for users because it suggests a single file example (example.go) that isn’t in the repo.
After searching, I decided to change the suggestion itself and add a link to the existing directory with all the examples:

  • See example.go for an end-to-end example of how to use the CDP SDK. > See the Go examples directory in the CDP SDK repository for runnable end‑to‑end usage examples.
  • https://github.com/coinbase/cdp-sdk/tree/main/examples/go/example.go > https://github.com/coinbase/cdp-sdk/tree/main/examples/go/

Tests

Verified that the link works and leads to runnable Go examples.
This change does not affect functionality, only fixes a broken documentation link.
No code changes were made.

Checklist

A couple of things to include in your PR for completeness:

  • Updated the typescript README if relevant
  • Updated the python README if relevant
  • Added a changelog entry
  • Added e2e tests if introducing new functionality

@cb-heimdall
Copy link

🟡 Heimdall Review Status

Requirement Status More Info
Reviews 🟡 0/1
Denominator calculation
Show calculation
1 if user is bot 0
1 if user is external 0
2 if repo is sensitive 0
From .codeflow.yml 1
Additional review requirements
Show calculation
Max 0
0
From CODEOWNERS 0
Global minimum 0
Max 1
1
1 if commit is unverified 0
Sum 1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants