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.

Sign up for GitHub

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

Jump to bottom

investiate expanded SDK docs #3055

Open

bgrenon opened this issue Feb 28, 2025 · 1 comment

Collaborator

bgrenon commented Feb 28, 2025

Our current TypeScript SDK docs are minimal. We could enhance them to better support people using @neondatabase/api-client.

Claude's suggestion:
Quick Start

Installation
Basic setup
First API call
Links to next steps

Usage Guide

Common operations
Basic patterns
Error handling
Link to API reference

API Reference

Link to full HTTP API docs
TypeScript types
Method signatures

The text was updated successfully, but these errors were encountered:

Collaborator Author

bgrenon commented Mar 28, 2025

Review the latest updates to see if they are adequate, or do we still need more improvements?
Possibly Fern.

bgrenon changed the title ~~expand SDK docs~~ investiate expanded SDK docs

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