Skip to content

davila7/claude-code-templates / cli-tool/components/skills/database/using-neon

using-neon

Flagged

Guides and best practices for working with Neon Serverless Postgres. Covers getting started, local development with Neon, choosing a connection method, Neon features, authentication (@neondatabase/auth), PostgREST-style data API (@neondatabase/neon-js), Neon CLI, and Neon's Platform API/SDKs. Use for any Neon-related questions.

references/referencing-docs.md

View on GitHub
# Referencing Neon Docs

The Neon documentation is the source of truth for all Neon-related information. Always verify Neon-related claims, configurations, and best practices against the official documentation.

## Getting the Documentation Index

To get a list of all available Neon documentation pages:

```bash
curl https://neon.tech/llms.txt
```

This returns an index of all documentation pages with their URLs and descriptions.

## Fetching Individual Documentation Pages

To fetch any documentation page as markdown for review:

```bash
curl -H "Accept: text/markdown" https://neon.tech/docs/<path>
```

**Examples:**

```bash
# Fetch the API reference
curl -H "Accept: text/markdown" https://neon.tech/docs/reference/api-reference

# Fetch connection pooling docs
curl -H "Accept: text/markdown" https://neon.tech/docs/connect/connection-pooling

# Fetch branching documentation
curl -H "Accept: text/markdown" https://neon.tech/docs/introduction/branching

# Fetch serverless driver docs
curl -H "Accept: text/markdown" https://neon.tech/docs/serverless/serverless-driver
```

## Common Documentation Paths

| Topic              | Path                                 |
| ------------------ | ------------------------------------ |
| Introduction       | `/docs/introduction`                 |
| Branching          | `/docs/introduction/branching`       |
| Autoscaling        | `/docs/introduction/autoscaling`     |
| Scale to Zero      | `/docs/introduction/scale-to-zero`   |
| Connection Pooling | `/docs/connect/connection-pooling`   |
| Serverless Driver  | `/docs/serverless/serverless-driver` |
| JavaScript SDK     | `/docs/reference/javascript-sdk`     |
| API Reference      | `/docs/reference/api-reference`      |
| TypeScript SDK     | `/docs/reference/typescript-sdk`     |
| Python SDK         | `/docs/reference/python-sdk`         |

## Framework and Language Guides

```bash
# Next.js
curl -H "Accept: text/markdown" https://neon.tech/docs/guides/nextjs

# Django
curl -H "Accept: text/markdown" https://neon.tech/docs/guides/django

# Drizzle ORM
curl -H "Accept: text/markdown" https://neon.tech/docs/guides/drizzle

# Prisma
curl -H "Accept: text/markdown" https://neon.tech/docs/guides/prisma
```

## Best Practices

1. **Always verify** - When answering questions about Neon features, APIs, or configurations, fetch the relevant documentation to verify your response is accurate.

2. **Check llms.txt first** - If you're unsure which documentation page covers a topic, fetch the llms.txt index to find the relevant URL. Don't make up URLs.

3. **Docs are the source of truth** - If there's any conflict between your training data and the documentation, the documentation is correct. Neon features and APIs evolve, so always defer to the current docs.

4. **Cite your sources** - When providing information from the docs, reference the documentation URL so users can read more if needed.
deprecation-and-migrationaddyosmani/agent-skillsManages deprecation and migration. Use when removing old systems, APIs, or features. Use when migrating users from one implementation to another. Use when migrating a database schema in production, such as renaming or dropping a column without downtime (expand/contract). Use when deciding whether to maintain or sunset existing code.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
performance-optimizationaddyosmani/agent-skillsOptimizes application performance across frontend, backend, queries, and databases. Use when performance requirements exist, when you suspect performance regressions, when Core Web Vitals or load times need improvement, when N+1 query patterns need fixing, or when profiling reveals bottlenecks.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
Agent Cost Reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json.Stars: 118kUpdated Claude CodeCodexVerifiedInstall
Agent Cost Reportthedotmack/claude-memBelievable agent cost report for any period, default the last 7 full days PT, not counting today. Measured tokens from Claude Code transcripts priced at OpenRouter list prices (ESTIMATED), measured provider spend when a sanctioned source exists, note-taker cost separate, Timing-style HTML/PDF plus report.json, line-items.csv, evidence.json.Stars: 118kUpdated Claude CodeCodexVerifiedInstall