ProjectOpenSea / opensea-js / 18541823153

88%

master: 30%

push

github

docs: add API reference links and refresh getting-started guide (#1788)

* docs: add links to API reference documentation

Add links to the new API reference documentation throughout the developer docs to make it discoverable.

## Changes

- **README.md**: Added API Reference link in the Documentation section with description "Complete reference for all SDK methods"
- **quick-start.md**: Added reference link at the top of the guide
- **getting-started.md**: Added reference link at the top with note about detailed parameters and return types
- **advanced-use-cases.md**: Added reference link at the top
- **faq.md**: Updated "Why is there no SDK method" answer to point users to API Reference first

The API Reference documentation (api-reference.md) was added in PR #1787 but wasn't linked from anywhere, making it difficult for developers to discover. These changes ensure the comprehensive API documentation is easily accessible from all relevant locations.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* docs: refresh and improve getting-started guide

Comprehensively updated the getting-started guide to reflect the current state of the SDK and fix outdated information.

## Major Improvements

### Fixed Outdated Information
- Removed deprecated English auctions section (no longer supported on OpenSea)
- Removed broken references to non-existent "Using ERC-20 Tokens Instead of Ether" section
- Updated "Fetching Assets" to "Fetching NFTs" to match actual SDK terminology
- Fixed incorrect variable names (sdk -> openseaSDK for consistency)

### Enhanced Content Structure
- Reorganized table of contents to better reflect available features
- Moved "Creating Collection and Trait Offers" to proper section hierarchy
- Added clearer section headings and subsections
- Improved code examples with more complete imports

### Added Missing Information
- **Payment Token Clarification**: Added important not... (continued)

432 of 625 branches covered (69.12%)

Branch coverage included in aggregate %.

3885 of 4319 relevant lines covered (89.95%)

4.38 hits per line