From 82185302098b9da34ef8730271be1b2bd7510241 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 12:57:05 -0400 Subject: [PATCH 1/9] docs: document Next.js session caching configuration Add documentation for the optional NEON_AUTH_COOKIE_SECRET environment variable that enables local session data caching in Next.js applications. This feature reduces Auth Server API calls by 95-99% with a 5-minute cache TTL. Updated both Next.js quickstart guides: - Next.js with UI Components guide - Next.js with API methods guide The session caching feature is opt-in, fully backward compatible, and recommended for production environments. Related: neondatabase/neon-js#35 --- content/docs/auth/quick-start/nextjs-api-only.md | 4 ++++ content/docs/auth/quick-start/nextjs.md | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/content/docs/auth/quick-start/nextjs-api-only.md b/content/docs/auth/quick-start/nextjs-api-only.md index 24dd5ab375..cd47f68f3b 100644 --- a/content/docs/auth/quick-start/nextjs-api-only.md +++ b/content/docs/auth/quick-start/nextjs-api-only.md @@ -2,7 +2,11 @@ title: Use Neon Auth with Next.js (API methods) subtitle: Build your own auth UI using SDK methods enableTableOfContents: true +<<<<<<< HEAD updatedOn: '2026-01-30T14:03:06.272Z' +======= +updatedOn: '2026-01-24T00:00:00.000Z' +>>>>>>> dc48e230d (docs: document Next.js session caching configuration) layout: wide --- diff --git a/content/docs/auth/quick-start/nextjs.md b/content/docs/auth/quick-start/nextjs.md index 2abce1185f..679ea72152 100644 --- a/content/docs/auth/quick-start/nextjs.md +++ b/content/docs/auth/quick-start/nextjs.md @@ -2,7 +2,11 @@ title: Use Neon Auth with Next.js (UI Components) subtitle: Set up authentication in Next.js using pre-built UI components enableTableOfContents: true +<<<<<<< HEAD updatedOn: '2026-01-30T14:03:06.274Z' +======= +updatedOn: '2026-01-24T00:00:00.000Z' +>>>>>>> dc48e230d (docs: document Next.js session caching configuration) layout: wide --- From a3417fb0a618e5cc6719049a4b440d1f826a5747 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 13:03:48 -0400 Subject: [PATCH 2/9] chore: improve SDK doc sync rules based on session caching update Enhanced the neon-js SDK documentation sync workflow rules based on learnings from documenting PR #35 (session caching feature). Key improvements: - Added Documentation Scope Decision Tree to distinguish between client SDK, Next.js server-side, and framework-specific changes - Added complete guidance for updating Next.js quickstart guides - Expanded user-facing changes checklist to include server-side features - Enhanced summary template to categorize changes by documentation type - Updated execution checklist with scope determination and frontmatter updates These changes ensure the workflow accurately handles both client-side SDK API changes and framework-specific server-side features. --- .cursor/rules/neon-js-sdk-doc-sync.md | 390 ++++++++++++++++++++++++++ 1 file changed, 390 insertions(+) create mode 100644 .cursor/rules/neon-js-sdk-doc-sync.md diff --git a/.cursor/rules/neon-js-sdk-doc-sync.md b/.cursor/rules/neon-js-sdk-doc-sync.md new file mode 100644 index 0000000000..4025c9732f --- /dev/null +++ b/.cursor/rules/neon-js-sdk-doc-sync.md @@ -0,0 +1,390 @@ +# Neon JavaScript SDK Documentation Sync + +## Purpose +This rule guides the process of reviewing merged PRs from the neon-js repository and updating the user-facing SDK documentation in the website repository to reflect API changes. + +## When to Apply +Apply this rule when asked to: +- "Review the latest neon-js PRs" +- "Update SDK docs from neon-js changes" +- "Sync JavaScript SDK documentation" +- "Check for SDK API changes" + +## Repositories + +### Source Repository (SDK Code) +- **Repo:** `neondatabase/neon-js` +- **URL:** https://github.com/neondatabase/neon-js +- **Access:** Use GitHub MCP tools to fetch PRs and file changes + +### Documentation Repository (This Repo) +- **Files to Update:** + - `content/docs/reference/javascript-sdk.md` - Main SDK reference documentation + - `content/docs/sdk-navigation.yaml` - Table of contents structure (if new methods added) + - `content/docs/auth/quick-start/nextjs.md` - Next.js with UI Components guide + - `content/docs/auth/quick-start/nextjs-api-only.md` - Next.js with API methods guide + - `public/llms/reference-javascript-sdk.txt` - Auto-generated during build, do not edit manually + +## Documentation Scope Decision Tree + +Before updating documentation, determine WHERE to document the change: + +### Client-Side SDK API Changes +**Target:** `content/docs/reference/javascript-sdk.md` +- New methods on `client.auth.*` or `client.from()` +- New client-side adapter methods +- Client-side query builders and filters +- Methods used in React components via hooks + +### Next.js Server-Side Features +**Target:** Next.js quickstart guides +- `content/docs/auth/quick-start/nextjs.md` (UI Components) +- `content/docs/auth/quick-start/nextjs-api-only.md` (API methods) + +Changes affecting: +- `neonAuth()` helper function +- `neonAuthMiddleware()` configuration +- `authApiHandler()` behavior +- Server-side environment variables +- Server-side performance optimizations +- `authServer.*` methods + +### Framework-Specific Guides +**Target:** Respective framework documentation +- React-specific features → React guides +- Next.js App Router features → Next.js guides +- Adapter changes → Integration guides + +### Example Mapping: +- ✅ New `client.auth.signIn.passkey()` → `javascript-sdk.md` +- ✅ New `NEON_AUTH_COOKIE_SECRET` env var → Next.js quickstart guides +- ✅ New middleware option → Next.js quickstart guides +- ✅ New React hook → React guide + SDK reference + +## Workflow + +### Step 1: Fetch Recent Merged PRs +Use the GitHub MCP tool to fetch merged PRs from the last 7 days: +``` +owner: neondatabase +repo: neon-js +state: closed (filter to merged only) +sort: updated +direction: desc +``` + +Ask user which time period if unclear (default: last 7 days). + +### Step 2: Review Each PR for User-Facing Changes + +For each PR, determine if it contains **user-facing API changes**: + +#### ✅ User-Facing Changes (DOCUMENT THESE) +- New authentication methods (e.g., `auth.signIn.social()`, `auth.signUp.email()`) +- New database query methods (e.g., `.select()`, `.insert()`, `.update()`) +- New filter methods (e.g., `.eq()`, `.gt()`, `.like()`) +- Changed method signatures (added/removed parameters) +- New adapters (e.g., BetterAuthReactAdapter, SupabaseAuthAdapter) +- New return types or response structures +- New configuration options in `createClient()` or `createAuthClient()` +- New Next.js middleware options or behavior +- New environment variables for server-side features +- Server-side performance optimizations (caching, etc.) +- Changes to server-side helper functions (`neonAuth()`, `authServer.*`) +- Deprecated methods (mark with deprecation note) +- Breaking changes to public API + +#### ❌ Internal Changes (DO NOT DOCUMENT) +- Refactoring internal code structure +- Performance optimizations that don't change API +- Bug fixes that don't change behavior +- Testing improvements +- Build system changes +- CI/CD pipeline updates +- Internal utility functions +- Type definitions that don't affect public API usage + +### Step 3: Analyze PR Changes + +For PRs with user-facing changes: + +1. **Read the PR description** - Understanding the "why" and intended use case +2. **Review changed files** - Focus on: + - `packages/*/src/**/*.ts` - Public API files + - `packages/*/README.md` - Usage examples + - `examples/**/*` - Example implementations +3. **Identify specific changes**: + - New exports + - Changed function signatures + - New parameters or options + - Modified return types + - New adapter methods + +### Step 4: Update SDK Documentation + +#### Main Documentation File +**Location:** `content/docs/reference/javascript-sdk.md` + +**Update patterns based on change type:** + +##### Adding a New Method +```markdown + + + +Brief description of what the method does. + +- Key behavior point 1 +- Key behavior point 2 +- Key behavior point 3 + +### Parameters + +
+View parameters + +| Parameter | Type | Required | +| -------------------- | ------------------- | -------- | +| paramName | string | ✓ | +| optionalParam | string \| undefined | | + +
+ + + + +```typescript +const result = await client.auth.methodName({ + paramName: 'value', + optionalParam: 'optional value' +}) + +if (result.error) { + console.error('Error:', result.error.message) +} else { + console.log('Success:', result.data) +} +``` + + + +``` + +##### Updating an Existing Method +1. Locate the method by searching for its `id` attribute +2. Update the description if behavior changed +3. Update the parameters table if parameters changed +4. Update code examples if signature changed +5. Add notes about breaking changes if applicable + +##### Adding Multiple Code Examples +Use `CodeTabs` for multiple examples: +```markdown + + +```typescript +// Example 1 +``` + +```typescript +// Example 2 +``` + +```typescript +// Example 3 +``` + + +``` + +#### Navigation File (if needed) +**Location:** `content/docs/sdk-navigation.yaml` + +Update ONLY if adding entirely new methods. Add entries under appropriate section: + +```yaml +reference/javascript-sdk: + title: Neon Auth & Data API TypeScript SDKs + sections: + - section: Auth + items: + - title: New method name + id: unique-id-matching-markdown +``` + +**Section mappings:** +- `Getting Started` - Installation and initialization +- `Auth` - Authentication methods (`auth.signIn.*`, `auth.signUp.*`, etc.) +- `Database` - CRUD operations (`from()`, `.select()`, `.insert()`, etc.) +- `Filters` - Query filters (`.eq()`, `.gt()`, `.like()`, etc.) + +#### Next.js Quickstart Guides (Server-Side Features) +**Locations:** +- `content/docs/auth/quick-start/nextjs.md` - UI Components guide +- `content/docs/auth/quick-start/nextjs-api-only.md` - API methods guide + +**When to update:** +- New environment variables affecting Next.js +- Changes to `neonAuthMiddleware()` configuration +- New server-side helper methods +- Performance optimizations for server components +- Changes to API route handlers + +**Update patterns:** + +##### Adding Environment Variable Documentation +Locate the "Set up environment variables" step and add to the Admonition: +```markdown + +Add `ENV_VAR_NAME` to enable [feature description]. This [performance benefit or functionality]. + +[Technical details: TTL, validation, security notes] + +This feature is opt-in and fully backward compatible. Without this variable, [fallback behavior]. + +``` + +Update the code block to include the new variable: +```bash +NEON_AUTH_BASE_URL=https://... + +# Optional: Feature description (recommended for production) +NEW_ENV_VAR=example-value +``` + +##### Update frontmatter date: +```yaml +updatedOn: 'YYYY-MM-DDTHH:MM:SS.000Z' +``` + +### Step 5: Documentation Quality Standards + +Ensure all updates follow these standards: + +1. **Clarity** - Use clear, simple language +2. **Completeness** - Include all parameters and return types +3. **Examples** - Provide realistic, copy-paste ready examples +4. **Error Handling** - Show error handling patterns +5. **Consistency** - Match existing documentation style and voice +6. **Accuracy** - Verify against actual SDK code + +### Step 6: Create Summary + +After completing updates, provide a summary: + +```markdown +## SDK Documentation Updates from neon-js PRs + +### PRs Reviewed: [count] +- PR #X: [title] - User-facing: Yes/No - Scope: Client SDK / Next.js / Framework +- PR #Y: [title] - User-facing: Yes/No - Scope: Client SDK / Next.js / Framework + +### Documentation Changes Made: + +#### Client SDK Reference +1. **Added method**: `auth.newMethod()` + - File: content/docs/reference/javascript-sdk.md + - Section: Auth + +2. **Updated method**: `auth.existingMethod()` + - Changed: Added new optional parameter + - File: content/docs/reference/javascript-sdk.md + +3. **Updated navigation**: + - Added entry for new method + - File: content/docs/sdk-navigation.yaml + +#### Next.js Guides +1. **Added configuration**: `NEON_AUTH_COOKIE_SECRET` + - Files: + - content/docs/auth/quick-start/nextjs.md + - content/docs/auth/quick-start/nextjs-api-only.md + - Section: Environment variables + +#### Framework Guides +1. **Updated guide**: [Framework name] + - File: content/docs/[path] + - Change: [description] + +### No Documentation Changes Needed: +- PR #Z: Internal refactoring only +``` + +## Important Notes + +### What NOT to Update +- **LLM text file** (`public/llms/reference-javascript-sdk.txt`) - This is auto-generated during build +- **Internal documentation** - Focus only on user-facing SDK reference +- **Tutorial pages** - Only update the reference documentation unless specifically asked + +### Multiple Guides May Need Updates +Some changes affect multiple documentation files: +- New auth method might need updates in SDK reference AND framework guides +- Environment variable changes might need updates in multiple quickstart guides +- Always check if related guides need updates for consistency + +### Method ID Conventions +- Use kebab-case: `auth-signinwithpassword` +- Be descriptive: `auth-sendverificationotp` +- Match the method purpose, not just the function name + +### Code Example Standards +- Use TypeScript for all examples +- Show full import statements in first example +- Include error handling with `if (result.error)` +- Use realistic variable names +- Keep examples concise but complete + +### Breaking Changes +If a PR introduces breaking changes: +1. Add an `Admonition` component with type "important" +2. Clearly describe what changed +3. Provide migration example (old → new) + +Example: +```markdown + +The `auth.signIn()` method signature has changed. The `rememberMe` parameter is now part of the options object. + +**Before:** +```typescript +await auth.signIn(email, password, true) +``` + +**After:** +```typescript +await auth.signIn.email({ email, password, rememberMe: true }) +``` + +``` + +## Execution Checklist + +When syncing documentation: +- [ ] Fetch merged PRs from neon-js repo +- [ ] Review each PR description and changes +- [ ] Identify user-facing changes only +- [ ] Determine documentation scope (Client SDK vs Next.js vs Framework) +- [ ] Update `javascript-sdk.md` with new/changed client methods (if applicable) +- [ ] Update `sdk-navigation.yaml` if new methods added (if applicable) +- [ ] Update Next.js quickstart guides for server-side changes (if applicable) +- [ ] Update framework-specific guides as needed (if applicable) +- [ ] Follow appropriate component patterns (TwoColumnLayout, Admonition, etc.) +- [ ] Include code examples for all changes +- [ ] Verify parameter tables are complete +- [ ] Update frontmatter dates on modified files +- [ ] Check for breaking changes and document appropriately +- [ ] Create summary of changes made +- [ ] Test locally with `npm run dev` (if requested) + +## Example Usage + +**User request:** +> "Review the latest PRs from neon-js and update the SDK docs" + +**Your response:** +1. Fetch last 7 days of merged PRs from neondatabase/neon-js +2. List PRs found with brief description +3. Analyze each for user-facing changes +4. Update documentation files as needed +5. Provide summary of changes made From c501d48be22fb5db6ed34d938e2ea798fd8d1bd5 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 13:06:41 -0400 Subject: [PATCH 3/9] chore: move neon-changelog.rules to rules directory Organize Cursor configuration by moving the changelog generator rules file into the .cursor/rules/ directory for better structure. --- .cursor/{ => rules}/neon-changelog.rules | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) rename .cursor/{ => rules}/neon-changelog.rules (97%) diff --git a/.cursor/neon-changelog.rules b/.cursor/rules/neon-changelog.rules similarity index 97% rename from .cursor/neon-changelog.rules rename to .cursor/rules/neon-changelog.rules index 33e476a357..13cfa11bb3 100644 --- a/.cursor/neon-changelog.rules +++ b/.cursor/rules/neon-changelog.rules @@ -73,7 +73,7 @@ rules: notes: | # How to use (documentation only; safe to keep in rules) - - **Create next Friday’s draft (typical):** + - **Create next Friday's draft (typical):** - Run: `generate:changelog` - Optional: set `TIMEZONE` (default `America/New_York`). - **Create for a specific date (backfill / special case):** @@ -142,4 +142,4 @@ rules: Notes: - If a file already exists for the computed or specified date, no file is written. - - The template includes a collapsible “Fixes & improvements” section. + - The template includes a collapsible "Fixes & improvements" section. From 3211a8eaeee5491f4c16e1b274237c3ecc179cf7 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 13:12:29 -0400 Subject: [PATCH 4/9] chore: add MCP server documentation sync workflow rules Created comprehensive rules for syncing documentation from the neondatabase-labs/mcp-server-neon repository to the website docs. Key features: - Documentation scope decision tree (tools vs setup vs client-specific) - Guidance for updating 3 reference docs and 7 client-specific guides - Detailed update patterns for MCP tools list - Security-first approach for powerful MCP capabilities - Client-specific setup variations (Claude, Cursor, VS Code, etc.) - Complete workflow from PR review to documentation updates This enables systematic documentation updates when new MCP tools, setup improvements, or client integrations are added to the server. --- .cursor/rules/mcp-server-doc-sync.md | 358 +++++++++++++++++++++++++++ 1 file changed, 358 insertions(+) create mode 100644 .cursor/rules/mcp-server-doc-sync.md diff --git a/.cursor/rules/mcp-server-doc-sync.md b/.cursor/rules/mcp-server-doc-sync.md new file mode 100644 index 0000000000..8f24f3c43c --- /dev/null +++ b/.cursor/rules/mcp-server-doc-sync.md @@ -0,0 +1,358 @@ +# Neon MCP Server Documentation Sync + +## Purpose +This rule guides the process of reviewing merged PRs from the mcp-server-neon repository and updating the user-facing MCP server documentation in the website repository to reflect new features, tools, and setup changes. + +## When to Apply +Apply this rule when asked to: +- "Review the latest mcp-server-neon PRs" +- "Update MCP server docs from recent changes" +- "Sync MCP server documentation" +- "Check for MCP server updates" + +## Repositories + +### Source Repository (MCP Server Code) +- **Repo:** `neondatabase-labs/mcp-server-neon` +- **URL:** https://github.com/neondatabase-labs/mcp-server-neon +- **Access:** Use WebFetch to retrieve PRs page (GitHub MCP tools may have auth issues) + +### Documentation Repository (This Repo) +- **Files to Update:** + - **Reference Documentation:** + - `content/docs/ai/neon-mcp-server.md` - Main MCP server overview and setup + - `content/docs/ai/connect-mcp-clients-to-neon.md` - Client connection guide + - `content/docs/shared-content/mcp-tools.md` - Complete tools list + - **Client-Specific Guides:** + - `content/guides/neon-mcp-server.md` - Claude Desktop guide + - `content/guides/cursor-mcp-neon.md` - Cursor setup + - `content/guides/claude-code-mcp-neon.md` - Claude Code setup + - `content/guides/zed-mcp-neon.md` - Zed setup + - `content/guides/windsurf-mcp-neon.md` - Windsurf setup + - `content/guides/cline-mcp-neon.md` - Cline setup + - `content/guides/neon-mcp-server-github-copilot-vs-code.md` - VS Code/Copilot setup + +## Documentation Scope Decision Tree + +Before updating documentation, determine WHERE to document the change: + +### New MCP Tools +**Target:** `content/docs/shared-content/mcp-tools.md` +- New tools added to the server +- Changed tool parameters or behavior +- Deprecated tools (mark with note) +- Tool categorization changes + +### Server Setup & Configuration +**Target:** Reference docs AND affected client guides +- OAuth improvements → Update `neon-mcp-server.md` + all client guides +- Remote server URL changes → Update all client guides +- Authentication changes → Update setup sections in reference + guides +- New supported clients → Create new guide + update reference docs + +### Client-Specific Features +**Target:** Specific client guide only +- Cursor-specific configuration → `cursor-mcp-neon.md` +- Claude Desktop connectors → `neon-mcp-server.md` (Claude Desktop section) +- VS Code settings → `neon-mcp-server-github-copilot-vs-code.md` + +### Security & Best Practices +**Target:** Reference docs +- New security considerations → Update admonitions in `neon-mcp-server.md` +- OAuth scope changes → Update authentication sections +- API key handling changes → Update setup instructions + +### Example Mapping: +- ✅ New `provision_neon_auth` tool → `mcp-tools.md` +- ✅ OAuth improvements → `neon-mcp-server.md` + all client guides +- ✅ New traceId for logging → Reference docs (if user-facing) or skip (if internal) +- ✅ Cursor one-click install → `cursor-mcp-neon.md` + `neon-mcp-server.md` + +## Workflow + +### Step 1: Fetch Recent Merged PRs +Use WebFetch to fetch merged PRs from the last 7 days: +``` +URL: https://github.com/neondatabase-labs/mcp-server-neon/pulls?q=is:pr+is:merged+merged:>YYYY-MM-DD +``` + +Calculate the date 7 days ago from today (or ask user for time period). + +### Step 2: Review Each PR for User-Facing Changes + +For each PR, determine if it contains **user-facing changes**: + +#### ✅ User-Facing Changes (DOCUMENT THESE) +- New MCP tools (e.g., `provision_neon_auth`, `search`, `fetch`) +- Changed tool parameters or behavior +- New setup methods or clients supported +- OAuth authentication improvements +- Remote server URL changes +- Security guidance updates +- Breaking changes to tool APIs +- Setup workflow improvements (e.g., one-click install buttons) +- New configuration options +- Documentation resource updates (load_resource content) + +#### ❌ Internal Changes (DO NOT DOCUMENT) +- Refactoring internal code structure +- Performance optimizations that don't change behavior +- CI/CD pipeline updates +- Testing improvements +- Build system changes +- Internal logging improvements (unless user-visible) +- Vercel deployment infrastructure +- Internal error handling (unless changes user experience) + +### Step 3: Analyze PR Changes + +For PRs with user-facing changes: + +1. **Read the PR description** - Understanding the feature and its purpose +2. **Review changed files** - Focus on: + - `src/tools/**/*.ts` - New or modified tools + - `src/server.ts` - Server configuration changes + - `README.md` - Setup instruction changes + - `docs/**` - Documentation updates +3. **Identify specific changes**: + - New tool names and descriptions + - Changed tool parameters + - New OAuth scopes or authentication methods + - Setup process modifications + - New client support + +### Step 4: Update Documentation + +#### A. Tools List (`content/docs/shared-content/mcp-tools.md`) + +**When to update:** +- New tools added +- Tool parameters changed +- Tool descriptions improved +- Tools deprecated or removed + +**Update pattern:** + +```markdown +**Category name:** + +- `tool_name`: Description of what the tool does. Important details about parameters or behavior. +``` + +**Categories:** +- Project management +- Branch management +- SQL query execution +- Database migrations (schema changes) +- Query performance optimization +- Neon Auth +- Neon Data API +- Search and discovery +- Documentation and resources + +**Update frontmatter date:** +```yaml +updatedOn: 'YYYY-MM-DDTHH:MM:SS.000Z' +``` + +#### B. Reference Documentation + +##### Main Overview (`content/docs/ai/neon-mcp-server.md`) + +**When to update:** +- OAuth authentication changes +- Security considerations updates +- New setup options +- Remote server URL changes +- New client support announcements + +**Key sections to maintain:** +- Get started (quick command) +- Understanding MCP and Neon MCP Server +- Setup options (remote vs local) +- Security considerations (Admonition blocks) +- Prerequisites + +**Update pattern for security:** +```markdown + +[Update security guidance based on new features or concerns] + +``` + +##### Client Connection Guide (`content/docs/ai/connect-mcp-clients-to-neon.md`) + +**When to update:** +- New client supported +- Setup process changes +- Configuration format changes + +**Structure:** +- Prerequisites section +- Setup steps per client +- Troubleshooting guidance + +#### C. Client-Specific Guides + +**When to update:** +- Client-specific setup improvements +- New features for specific clients +- Configuration changes for that client + +**Standard structure for guides:** +1. Introduction with use case +2. Prerequisites +3. Setup steps (numbered) +4. Configuration examples +5. Verification steps +6. Next steps / related guides + +**Update pattern:** +```markdown +--- +title: 'Client Name and Neon MCP Server' +subtitle: 'Brief description' +author: author-name +enableTableOfContents: true +createdAt: 'YYYY-MM-DD' +updatedOn: 'YYYY-MM-DD' +--- + +[Introduction paragraph] + + +[Security note with link to main docs] + + +## Prerequisites +- List prerequisites + +## Setting up [Client Name] +[Numbered steps] + +## Verification +[How to verify setup works] +``` + +### Step 5: Documentation Quality Standards + +Ensure all updates follow these standards: + +1. **Clarity** - Use clear, simple language +2. **Completeness** - Include all setup steps and prerequisites +3. **Consistency** - Match existing documentation style and voice +4. **Security-First** - Always include security considerations +5. **Verification** - Provide ways to verify setup works +6. **Examples** - Include configuration examples +7. **Cross-linking** - Link to related guides and reference docs + +### Step 6: Create Summary + +After completing updates, provide a summary: + +```markdown +## MCP Server Documentation Updates + +### PRs Reviewed: [count] +- PR #X: [title] - User-facing: Yes/No - Scope: Tools / Setup / Client / Security + +### Documentation Changes Made: + +#### Tools Reference +1. **Added tool**: `tool_name` + - File: content/docs/shared-content/mcp-tools.md + - Category: [category] + +#### Reference Documentation +1. **Updated setup instructions**: OAuth improvements + - Files: + - content/docs/ai/neon-mcp-server.md + - Section: Setup options + +#### Client Guides +1. **Updated guide**: Cursor setup + - File: content/guides/cursor-mcp-neon.md + - Change: Added one-click install button + +### No Documentation Changes Needed: +- PR #Z: Internal refactoring only +``` + +## Important Notes + +### What NOT to Update +- Internal implementation details +- Vercel deployment specifics +- CI/CD workflows +- Testing infrastructure + +### Multiple Guides Often Need Updates +Some changes affect multiple files: +- New OAuth feature → Reference docs + all client guides +- New tool → Tools list only +- Security change → Reference docs + potentially all guides +- New client → New guide + reference docs + +### Tool List Organization +Tools are organized by functional category: +- Keep categories consistent +- Tools should be in logical order within category +- Include clear descriptions that explain user value +- Mention important parameters or behaviors + +### Security Considerations +Always review security implications: +- OAuth scope changes +- API key exposure risks +- Action authorization requirements +- Production use warnings + +### Client-Specific Variations +Different clients have different setup patterns: +- Claude Desktop: Connectors vs config file +- Cursor: One-click install vs manual config +- VS Code: Extension-specific settings +- Others: Standard MCP client config + +## Execution Checklist + +When syncing documentation: +- [ ] Fetch merged PRs from mcp-server-neon repo (last 7 days) +- [ ] Review each PR description and changes +- [ ] Identify user-facing changes only +- [ ] Determine documentation scope (Tools / Setup / Client / Security) +- [ ] Update `mcp-tools.md` if new or changed tools +- [ ] Update reference docs if setup or server changes +- [ ] Update client guides if client-specific changes +- [ ] Update security admonitions if security implications +- [ ] Update frontmatter dates on all modified files +- [ ] Check for cross-guide consistency +- [ ] Verify all links work +- [ ] Create summary of changes made + +## Example Usage + +**User request:** +> "Review the latest PRs from mcp-server-neon and update the MCP docs" + +**Your response:** +1. Fetch last 7 days of merged PRs from neondatabase-labs/mcp-server-neon +2. List PRs found with brief descriptions +3. Analyze each for user-facing changes +4. Update tools list, reference docs, and client guides as needed +5. Provide summary of changes made + +**Typical workflow:** +1. PR adds `provision_neon_data_api` tool + - Update `mcp-tools.md` with tool description in "Neon Data API" section + - Update frontmatter date + +2. PR improves OAuth flow + - Update `neon-mcp-server.md` OAuth setup section + - Update all client guides that mention OAuth + - Update frontmatter dates + +3. PR adds Cursor one-click install + - Add install button to `cursor-mcp-neon.md` + - Mention in `neon-mcp-server.md` if relevant + - Update frontmatter dates From e87c917ec8fc2b8aaccca8044d799618db42a68b Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 13:15:04 -0400 Subject: [PATCH 5/9] docs: emphasize shared component pattern in MCP doc sync rules Made the mcp-tools.md shared component pattern explicit and prominent: - Added important admonition about single source of truth - Updated Important Notes section with shared component guidance - Enhanced execution checklist with DO NOT duplicate warning - Clarified example workflow to show automatic propagation This ensures the tools list is only updated in one location and automatically propagates to all guides via the component. --- .cursor/rules/mcp-server-doc-sync.md | 31 +++++++++++++++++++++++----- 1 file changed, 26 insertions(+), 5 deletions(-) diff --git a/.cursor/rules/mcp-server-doc-sync.md b/.cursor/rules/mcp-server-doc-sync.md index 8f24f3c43c..ef068ece17 100644 --- a/.cursor/rules/mcp-server-doc-sync.md +++ b/.cursor/rules/mcp-server-doc-sync.md @@ -125,6 +125,16 @@ For PRs with user-facing changes: #### A. Tools List (`content/docs/shared-content/mcp-tools.md`) + +`mcp-tools.md` is a **shared component** used across multiple guides via the `` component. + +**NEVER duplicate the tools list in individual guides.** Update only this one file, and it automatically propagates to all guides that include ``. + +Guides using this component: +- `content/guides/neon-mcp-server.md` +- Other guides as needed + + **When to update:** - New tools added - Tool parameters changed @@ -258,10 +268,11 @@ After completing updates, provide a summary: ### Documentation Changes Made: -#### Tools Reference +#### Tools Reference (Shared Component) 1. **Added tool**: `tool_name` - - File: content/docs/shared-content/mcp-tools.md + - File: content/docs/shared-content/mcp-tools.md (shared component) - Category: [category] + - Note: Automatically propagates to all guides using `` #### Reference Documentation 1. **Updated setup instructions**: OAuth improvements @@ -286,10 +297,17 @@ After completing updates, provide a summary: - CI/CD workflows - Testing infrastructure +### Shared Component Pattern (CRITICAL) +**The tools list is a shared component:** +- `content/docs/shared-content/mcp-tools.md` is the **single source of truth** +- Guides include this via `` component +- **NEVER duplicate tool lists in individual guides** +- Update only `mcp-tools.md` and it propagates automatically to all guides + ### Multiple Guides Often Need Updates Some changes affect multiple files: - New OAuth feature → Reference docs + all client guides -- New tool → Tools list only +- New tool → **Tools list ONLY** (via shared component) - Security change → Reference docs + potentially all guides - New client → New guide + reference docs @@ -321,7 +339,8 @@ When syncing documentation: - [ ] Review each PR description and changes - [ ] Identify user-facing changes only - [ ] Determine documentation scope (Tools / Setup / Client / Security) -- [ ] Update `mcp-tools.md` if new or changed tools +- [ ] Update `mcp-tools.md` if new or changed tools (ONLY update this file - it's a shared component) +- [ ] DO NOT duplicate tools list in guides - they use `` component - [ ] Update reference docs if setup or server changes - [ ] Update client guides if client-specific changes - [ ] Update security admonitions if security implications @@ -344,8 +363,10 @@ When syncing documentation: **Typical workflow:** 1. PR adds `provision_neon_data_api` tool - - Update `mcp-tools.md` with tool description in "Neon Data API" section + - Update `mcp-tools.md` ONLY (shared component - don't touch guides) + - Add tool description in "Neon Data API" section - Update frontmatter date + - Tool automatically appears in all guides using `` 2. PR improves OAuth flow - Update `neon-mcp-server.md` OAuth setup section From b0c82b8c857a028d2254d5fd1725fab12849db4f Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 24 Jan 2026 13:17:40 -0400 Subject: [PATCH 6/9] feat: add source repo README sync to MCP doc workflow Added Step 6 to check and update the source repository's README when syncing MCP server documentation. Key additions: - Guidance on when to update the source repo README - Process for opening PRs to neondatabase-labs/mcp-server-neon - README sync section in Important Notes - Updated execution checklist with README verification - Enhanced example workflows showing README checks - Updated summary template to track README status This ensures the source repo's README stays in sync with website docs, providing consistent documentation for developers accessing the repo directly. --- .cursor/rules/mcp-server-doc-sync.md | 69 +++++++++++++++++++++++++++- 1 file changed, 67 insertions(+), 2 deletions(-) diff --git a/.cursor/rules/mcp-server-doc-sync.md b/.cursor/rules/mcp-server-doc-sync.md index ef068ece17..db08561968 100644 --- a/.cursor/rules/mcp-server-doc-sync.md +++ b/.cursor/rules/mcp-server-doc-sync.md @@ -256,7 +256,54 @@ Ensure all updates follow these standards: 6. **Examples** - Include configuration examples 7. **Cross-linking** - Link to related guides and reference docs -### Step 6: Create Summary +### Step 6: Update Source Repository README (if needed) + +**Check if the source repo README needs updates:** + +After reviewing PRs and updating website documentation, check if the README in the source repository also needs updates. + +**Repository:** https://github.com/neondatabase-labs/mcp-server-neon + +**When to update the source README:** +- New tools were added but README wasn't updated in the PR +- Tool descriptions in README are outdated or incomplete +- Setup instructions changed but README wasn't updated +- New features documented on website but missing from README + +**What to update in README:** +- Tools list (keep in sync with website's `mcp-tools.md`) +- Setup instructions (OAuth, configuration) +- Prerequisites +- Usage examples +- Security considerations + +**Process:** +1. Review the source repo's README.md +2. Identify gaps between README and website docs +3. If updates needed: + - Fork the repo (if not already) + - Create a new branch (e.g., `docs/update-readme-tools`) + - Update README.md + - Open a PR to `neondatabase-labs/mcp-server-neon` + - Title: "docs: update README with [new tools/features/setup]" + - Link to the website PR in the description + - Mention which website docs were updated for context + +**Example PR description:** +```markdown +## Summary +Updates README to document [feature/tools] that were added in PR #X but not reflected in the README. + +## Changes +- Added tool descriptions for `tool_name_1`, `tool_name_2` +- Updated setup instructions for [feature] + +## Related +- Website documentation updated in neondatabase/website#[PR number] +- Implements documentation for PR #X +``` + +### Step 7: Create Summary After completing updates, provide a summary: @@ -285,6 +332,11 @@ After completing updates, provide a summary: - File: content/guides/cursor-mcp-neon.md - Change: Added one-click install button +#### Source Repository README +1. **Status**: README needs update / README already up to date + - Repo: neondatabase-labs/mcp-server-neon + - Action: [Opened PR #X / No action needed] + ### No Documentation Changes Needed: - PR #Z: Internal refactoring only ``` @@ -304,6 +356,14 @@ After completing updates, provide a summary: - **NEVER duplicate tool lists in individual guides** - Update only `mcp-tools.md` and it propagates automatically to all guides +### Source Repository README Sync +**Keep the source repo README in sync:** +- The README in `neondatabase-labs/mcp-server-neon` also documents MCP tools and setup +- After updating website docs, **always check** if README needs updates +- If PRs didn't update README but added features/tools, open a PR to update it +- README serves developers who go directly to the GitHub repo +- Link between website PR and source repo PR for traceability + ### Multiple Guides Often Need Updates Some changes affect multiple files: - New OAuth feature → Reference docs + all client guides @@ -347,7 +407,9 @@ When syncing documentation: - [ ] Update frontmatter dates on all modified files - [ ] Check for cross-guide consistency - [ ] Verify all links work -- [ ] Create summary of changes made +- [ ] **Check source repo README** for gaps vs website docs +- [ ] **Open PR to source repo** if README needs updates +- [ ] Create summary of changes made (including source repo README status) ## Example Usage @@ -367,13 +429,16 @@ When syncing documentation: - Add tool description in "Neon Data API" section - Update frontmatter date - Tool automatically appears in all guides using `` + - **Check source README**: If tool not documented there, open PR to add it 2. PR improves OAuth flow - Update `neon-mcp-server.md` OAuth setup section - Update all client guides that mention OAuth - Update frontmatter dates + - **Check source README**: Verify OAuth setup instructions are current 3. PR adds Cursor one-click install - Add install button to `cursor-mcp-neon.md` - Mention in `neon-mcp-server.md` if relevant - Update frontmatter dates + - **Check source README**: May not need update (client-specific feature) From a9efb3b52c990e37f4867a2f724ce8fad633a9d9 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 31 Jan 2026 11:13:03 -0400 Subject: [PATCH 7/9] chore: remove cursor rules files from PR --- .cursor/rules/mcp-server-doc-sync.md | 444 -------------------------- .cursor/rules/neon-changelog.rules | 145 --------- .cursor/rules/neon-js-sdk-doc-sync.md | 390 ---------------------- 3 files changed, 979 deletions(-) delete mode 100644 .cursor/rules/mcp-server-doc-sync.md delete mode 100644 .cursor/rules/neon-changelog.rules delete mode 100644 .cursor/rules/neon-js-sdk-doc-sync.md diff --git a/.cursor/rules/mcp-server-doc-sync.md b/.cursor/rules/mcp-server-doc-sync.md deleted file mode 100644 index db08561968..0000000000 --- a/.cursor/rules/mcp-server-doc-sync.md +++ /dev/null @@ -1,444 +0,0 @@ -# Neon MCP Server Documentation Sync - -## Purpose -This rule guides the process of reviewing merged PRs from the mcp-server-neon repository and updating the user-facing MCP server documentation in the website repository to reflect new features, tools, and setup changes. - -## When to Apply -Apply this rule when asked to: -- "Review the latest mcp-server-neon PRs" -- "Update MCP server docs from recent changes" -- "Sync MCP server documentation" -- "Check for MCP server updates" - -## Repositories - -### Source Repository (MCP Server Code) -- **Repo:** `neondatabase-labs/mcp-server-neon` -- **URL:** https://github.com/neondatabase-labs/mcp-server-neon -- **Access:** Use WebFetch to retrieve PRs page (GitHub MCP tools may have auth issues) - -### Documentation Repository (This Repo) -- **Files to Update:** - - **Reference Documentation:** - - `content/docs/ai/neon-mcp-server.md` - Main MCP server overview and setup - - `content/docs/ai/connect-mcp-clients-to-neon.md` - Client connection guide - - `content/docs/shared-content/mcp-tools.md` - Complete tools list - - **Client-Specific Guides:** - - `content/guides/neon-mcp-server.md` - Claude Desktop guide - - `content/guides/cursor-mcp-neon.md` - Cursor setup - - `content/guides/claude-code-mcp-neon.md` - Claude Code setup - - `content/guides/zed-mcp-neon.md` - Zed setup - - `content/guides/windsurf-mcp-neon.md` - Windsurf setup - - `content/guides/cline-mcp-neon.md` - Cline setup - - `content/guides/neon-mcp-server-github-copilot-vs-code.md` - VS Code/Copilot setup - -## Documentation Scope Decision Tree - -Before updating documentation, determine WHERE to document the change: - -### New MCP Tools -**Target:** `content/docs/shared-content/mcp-tools.md` -- New tools added to the server -- Changed tool parameters or behavior -- Deprecated tools (mark with note) -- Tool categorization changes - -### Server Setup & Configuration -**Target:** Reference docs AND affected client guides -- OAuth improvements → Update `neon-mcp-server.md` + all client guides -- Remote server URL changes → Update all client guides -- Authentication changes → Update setup sections in reference + guides -- New supported clients → Create new guide + update reference docs - -### Client-Specific Features -**Target:** Specific client guide only -- Cursor-specific configuration → `cursor-mcp-neon.md` -- Claude Desktop connectors → `neon-mcp-server.md` (Claude Desktop section) -- VS Code settings → `neon-mcp-server-github-copilot-vs-code.md` - -### Security & Best Practices -**Target:** Reference docs -- New security considerations → Update admonitions in `neon-mcp-server.md` -- OAuth scope changes → Update authentication sections -- API key handling changes → Update setup instructions - -### Example Mapping: -- ✅ New `provision_neon_auth` tool → `mcp-tools.md` -- ✅ OAuth improvements → `neon-mcp-server.md` + all client guides -- ✅ New traceId for logging → Reference docs (if user-facing) or skip (if internal) -- ✅ Cursor one-click install → `cursor-mcp-neon.md` + `neon-mcp-server.md` - -## Workflow - -### Step 1: Fetch Recent Merged PRs -Use WebFetch to fetch merged PRs from the last 7 days: -``` -URL: https://github.com/neondatabase-labs/mcp-server-neon/pulls?q=is:pr+is:merged+merged:>YYYY-MM-DD -``` - -Calculate the date 7 days ago from today (or ask user for time period). - -### Step 2: Review Each PR for User-Facing Changes - -For each PR, determine if it contains **user-facing changes**: - -#### ✅ User-Facing Changes (DOCUMENT THESE) -- New MCP tools (e.g., `provision_neon_auth`, `search`, `fetch`) -- Changed tool parameters or behavior -- New setup methods or clients supported -- OAuth authentication improvements -- Remote server URL changes -- Security guidance updates -- Breaking changes to tool APIs -- Setup workflow improvements (e.g., one-click install buttons) -- New configuration options -- Documentation resource updates (load_resource content) - -#### ❌ Internal Changes (DO NOT DOCUMENT) -- Refactoring internal code structure -- Performance optimizations that don't change behavior -- CI/CD pipeline updates -- Testing improvements -- Build system changes -- Internal logging improvements (unless user-visible) -- Vercel deployment infrastructure -- Internal error handling (unless changes user experience) - -### Step 3: Analyze PR Changes - -For PRs with user-facing changes: - -1. **Read the PR description** - Understanding the feature and its purpose -2. **Review changed files** - Focus on: - - `src/tools/**/*.ts` - New or modified tools - - `src/server.ts` - Server configuration changes - - `README.md` - Setup instruction changes - - `docs/**` - Documentation updates -3. **Identify specific changes**: - - New tool names and descriptions - - Changed tool parameters - - New OAuth scopes or authentication methods - - Setup process modifications - - New client support - -### Step 4: Update Documentation - -#### A. Tools List (`content/docs/shared-content/mcp-tools.md`) - - -`mcp-tools.md` is a **shared component** used across multiple guides via the `` component. - -**NEVER duplicate the tools list in individual guides.** Update only this one file, and it automatically propagates to all guides that include ``. - -Guides using this component: -- `content/guides/neon-mcp-server.md` -- Other guides as needed - - -**When to update:** -- New tools added -- Tool parameters changed -- Tool descriptions improved -- Tools deprecated or removed - -**Update pattern:** - -```markdown -**Category name:** - -- `tool_name`: Description of what the tool does. Important details about parameters or behavior. -``` - -**Categories:** -- Project management -- Branch management -- SQL query execution -- Database migrations (schema changes) -- Query performance optimization -- Neon Auth -- Neon Data API -- Search and discovery -- Documentation and resources - -**Update frontmatter date:** -```yaml -updatedOn: 'YYYY-MM-DDTHH:MM:SS.000Z' -``` - -#### B. Reference Documentation - -##### Main Overview (`content/docs/ai/neon-mcp-server.md`) - -**When to update:** -- OAuth authentication changes -- Security considerations updates -- New setup options -- Remote server URL changes -- New client support announcements - -**Key sections to maintain:** -- Get started (quick command) -- Understanding MCP and Neon MCP Server -- Setup options (remote vs local) -- Security considerations (Admonition blocks) -- Prerequisites - -**Update pattern for security:** -```markdown - -[Update security guidance based on new features or concerns] - -``` - -##### Client Connection Guide (`content/docs/ai/connect-mcp-clients-to-neon.md`) - -**When to update:** -- New client supported -- Setup process changes -- Configuration format changes - -**Structure:** -- Prerequisites section -- Setup steps per client -- Troubleshooting guidance - -#### C. Client-Specific Guides - -**When to update:** -- Client-specific setup improvements -- New features for specific clients -- Configuration changes for that client - -**Standard structure for guides:** -1. Introduction with use case -2. Prerequisites -3. Setup steps (numbered) -4. Configuration examples -5. Verification steps -6. Next steps / related guides - -**Update pattern:** -```markdown ---- -title: 'Client Name and Neon MCP Server' -subtitle: 'Brief description' -author: author-name -enableTableOfContents: true -createdAt: 'YYYY-MM-DD' -updatedOn: 'YYYY-MM-DD' ---- - -[Introduction paragraph] - - -[Security note with link to main docs] - - -## Prerequisites -- List prerequisites - -## Setting up [Client Name] -[Numbered steps] - -## Verification -[How to verify setup works] -``` - -### Step 5: Documentation Quality Standards - -Ensure all updates follow these standards: - -1. **Clarity** - Use clear, simple language -2. **Completeness** - Include all setup steps and prerequisites -3. **Consistency** - Match existing documentation style and voice -4. **Security-First** - Always include security considerations -5. **Verification** - Provide ways to verify setup works -6. **Examples** - Include configuration examples -7. **Cross-linking** - Link to related guides and reference docs - -### Step 6: Update Source Repository README (if needed) - -**Check if the source repo README needs updates:** - -After reviewing PRs and updating website documentation, check if the README in the source repository also needs updates. - -**Repository:** https://github.com/neondatabase-labs/mcp-server-neon - -**When to update the source README:** -- New tools were added but README wasn't updated in the PR -- Tool descriptions in README are outdated or incomplete -- Setup instructions changed but README wasn't updated -- New features documented on website but missing from README - -**What to update in README:** -- Tools list (keep in sync with website's `mcp-tools.md`) -- Setup instructions (OAuth, configuration) -- Prerequisites -- Usage examples -- Security considerations - -**Process:** -1. Review the source repo's README.md -2. Identify gaps between README and website docs -3. If updates needed: - - Fork the repo (if not already) - - Create a new branch (e.g., `docs/update-readme-tools`) - - Update README.md - - Open a PR to `neondatabase-labs/mcp-server-neon` - - Title: "docs: update README with [new tools/features/setup]" - - Link to the website PR in the description - - Mention which website docs were updated for context - -**Example PR description:** -```markdown -## Summary -Updates README to document [feature/tools] that were added in PR #X but not reflected in the README. - -## Changes -- Added tool descriptions for `tool_name_1`, `tool_name_2` -- Updated setup instructions for [feature] - -## Related -- Website documentation updated in neondatabase/website#[PR number] -- Implements documentation for PR #X -``` - -### Step 7: Create Summary - -After completing updates, provide a summary: - -```markdown -## MCP Server Documentation Updates - -### PRs Reviewed: [count] -- PR #X: [title] - User-facing: Yes/No - Scope: Tools / Setup / Client / Security - -### Documentation Changes Made: - -#### Tools Reference (Shared Component) -1. **Added tool**: `tool_name` - - File: content/docs/shared-content/mcp-tools.md (shared component) - - Category: [category] - - Note: Automatically propagates to all guides using `` - -#### Reference Documentation -1. **Updated setup instructions**: OAuth improvements - - Files: - - content/docs/ai/neon-mcp-server.md - - Section: Setup options - -#### Client Guides -1. **Updated guide**: Cursor setup - - File: content/guides/cursor-mcp-neon.md - - Change: Added one-click install button - -#### Source Repository README -1. **Status**: README needs update / README already up to date - - Repo: neondatabase-labs/mcp-server-neon - - Action: [Opened PR #X / No action needed] - -### No Documentation Changes Needed: -- PR #Z: Internal refactoring only -``` - -## Important Notes - -### What NOT to Update -- Internal implementation details -- Vercel deployment specifics -- CI/CD workflows -- Testing infrastructure - -### Shared Component Pattern (CRITICAL) -**The tools list is a shared component:** -- `content/docs/shared-content/mcp-tools.md` is the **single source of truth** -- Guides include this via `` component -- **NEVER duplicate tool lists in individual guides** -- Update only `mcp-tools.md` and it propagates automatically to all guides - -### Source Repository README Sync -**Keep the source repo README in sync:** -- The README in `neondatabase-labs/mcp-server-neon` also documents MCP tools and setup -- After updating website docs, **always check** if README needs updates -- If PRs didn't update README but added features/tools, open a PR to update it -- README serves developers who go directly to the GitHub repo -- Link between website PR and source repo PR for traceability - -### Multiple Guides Often Need Updates -Some changes affect multiple files: -- New OAuth feature → Reference docs + all client guides -- New tool → **Tools list ONLY** (via shared component) -- Security change → Reference docs + potentially all guides -- New client → New guide + reference docs - -### Tool List Organization -Tools are organized by functional category: -- Keep categories consistent -- Tools should be in logical order within category -- Include clear descriptions that explain user value -- Mention important parameters or behaviors - -### Security Considerations -Always review security implications: -- OAuth scope changes -- API key exposure risks -- Action authorization requirements -- Production use warnings - -### Client-Specific Variations -Different clients have different setup patterns: -- Claude Desktop: Connectors vs config file -- Cursor: One-click install vs manual config -- VS Code: Extension-specific settings -- Others: Standard MCP client config - -## Execution Checklist - -When syncing documentation: -- [ ] Fetch merged PRs from mcp-server-neon repo (last 7 days) -- [ ] Review each PR description and changes -- [ ] Identify user-facing changes only -- [ ] Determine documentation scope (Tools / Setup / Client / Security) -- [ ] Update `mcp-tools.md` if new or changed tools (ONLY update this file - it's a shared component) -- [ ] DO NOT duplicate tools list in guides - they use `` component -- [ ] Update reference docs if setup or server changes -- [ ] Update client guides if client-specific changes -- [ ] Update security admonitions if security implications -- [ ] Update frontmatter dates on all modified files -- [ ] Check for cross-guide consistency -- [ ] Verify all links work -- [ ] **Check source repo README** for gaps vs website docs -- [ ] **Open PR to source repo** if README needs updates -- [ ] Create summary of changes made (including source repo README status) - -## Example Usage - -**User request:** -> "Review the latest PRs from mcp-server-neon and update the MCP docs" - -**Your response:** -1. Fetch last 7 days of merged PRs from neondatabase-labs/mcp-server-neon -2. List PRs found with brief descriptions -3. Analyze each for user-facing changes -4. Update tools list, reference docs, and client guides as needed -5. Provide summary of changes made - -**Typical workflow:** -1. PR adds `provision_neon_data_api` tool - - Update `mcp-tools.md` ONLY (shared component - don't touch guides) - - Add tool description in "Neon Data API" section - - Update frontmatter date - - Tool automatically appears in all guides using `` - - **Check source README**: If tool not documented there, open PR to add it - -2. PR improves OAuth flow - - Update `neon-mcp-server.md` OAuth setup section - - Update all client guides that mention OAuth - - Update frontmatter dates - - **Check source README**: Verify OAuth setup instructions are current - -3. PR adds Cursor one-click install - - Add install button to `cursor-mcp-neon.md` - - Mention in `neon-mcp-server.md` if relevant - - Update frontmatter dates - - **Check source README**: May not need update (client-specific feature) diff --git a/.cursor/rules/neon-changelog.rules b/.cursor/rules/neon-changelog.rules deleted file mode 100644 index 13cfa11bb3..0000000000 --- a/.cursor/rules/neon-changelog.rules +++ /dev/null @@ -1,145 +0,0 @@ -rules: - - name: Neon Weekly Changelog Generator (next Friday) - description: > - Create the Neon weekly changelog for the next upcoming Friday (from now). - Writes content/changelog/YYYY-MM-DD.md with a consistent structure. - trigger: - command: generate:changelog - variables: - - key: TIMEZONE - default: America/New_York - description: IANA timezone used to compute "now" and next Friday. - instructions: | - You are generating a Neon weekly changelog file. - - ## Date logic (MUST DO) - - Use the IANA timezone in `${TIMEZONE}` (default America/New_York). - - Compute **next upcoming Friday** from the current moment in `${TIMEZONE}`: - - Let `today` be the current date in `${TIMEZONE}`. - - Let `dow` be Sunday=0 … Friday=5. - - `delta = (5 - dow + 7) % 7` - - If `delta === 0`, treat **today as Friday** and select **Friday of next week** (`add=7`) so drafts created on a Friday always target the *next* release. Otherwise `add=delta`. - - `target = today + add days` - - Format `target` as `YYYY-MM-DD` → `CHANGELOG_DATE`. - - Paths: - - `DEST_DIR = content/changelog` - - `FILENAME = ${CHANGELOG_DATE}.md` - - `DEST_PATH = ${DEST_DIR}/${FILENAME}` - - ## File rules - - If `${DEST_PATH}` already exists: STOP and report that the changelog file already exists. Do not overwrite. - - Otherwise, create `${DEST_PATH}` with the template below. - - ## Voice & content guidelines - - Friendly, concise, user-focused; sentence-style capitalization. - - Use H2 (`##`) for top-level sections. - - Feature headings should communicate user value, not just internal names. - - Each feature description: 1–3 sentences. - - Include optional image blocks where relevant. - - Always include a **Fixes & improvements** section as a collapsible `
`. - - **IMPORTANT**: Use only placeholder content (Lorem ipsum) and generic headings like "## New feature" - DO NOT create fictional features, improvements, or specific content. - - ## Markdown template (write exactly this shape, replacing bracketed placeholders) - --- - title: [Concise main theme of the release] - --- - - ## New feature - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. - - ## Another feature - - Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. - - ## Third feature - - Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. - -
- **Fixes & improvements** - - - [Short bullet describing a fix or improvement.] - - [Another short bullet, if applicable.] - -
- - ## Output requirements - - Save the file to `${DEST_PATH}` with the above content. - - After creation, print: - - `CHANGELOG_DATE` - - `DEST_PATH` - - A checklist of any `[placeholders]` still present. - - notes: | - # How to use (documentation only; safe to keep in rules) - - **Create next Friday's draft (typical):** - - Run: `generate:changelog` - - Optional: set `TIMEZONE` (default `America/New_York`). - - **Create for a specific date (backfill / special case):** - - Run: `generate:changelog:for` with `TARGET_DATE=YYYY-MM-DD`. - - **Show usage help:** - - Run: `generate:changelog:help` - - ### Helper (JS) — compute next Friday in a specific timezone (no external deps) - ```js - function nextFriday(tz = "America/New_York") { - const now = new Date(); - const fmt = new Intl.DateTimeFormat('en-CA', { - timeZone: tz, year: 'numeric', month: '2-digit', day: '2-digit', weekday: 'short' - }); - const parts = Object.fromEntries(fmt.formatToParts(now).map(p => [p.type, p.value])); - const base = new Date(`${parts.year}-${parts.month}-${parts.day}T00:00:00`); - const dow = base.getDay(); // 0..6 - const delta = (5 - dow + 7) % 7; // 5 = Friday - const add = (delta === 0 ? 7 : delta); - const friday = new Date(base.getTime() + add * 86400000); - const y = friday.getFullYear(); - const m = String(friday.getMonth() + 1).padStart(2, '0'); - const d = String(friday.getDate()).padStart(2, '0'); - return `${y}-${m}-${d}`; - } - ``` - - - name: Neon Weekly Changelog Generator (override date) - description: > - Create a Neon changelog for a specific date (YYYY-MM-DD) when you need to - backfill or pre-create a non-standard week. - trigger: - command: generate:changelog:for - variables: - - key: TARGET_DATE - description: Date string in YYYY-MM-DD (must be a valid calendar date). - instructions: | - - Validate `${TARGET_DATE}` is a valid `YYYY-MM-DD`. - - Use `${TARGET_DATE}` as `CHANGELOG_DATE`. - - Set: - - `DEST_DIR = content/changelog` - - `FILENAME = ${CHANGELOG_DATE}.md` - - `DEST_PATH = ${DEST_DIR}/${FILENAME}` - - If the file exists, STOP and report; otherwise create it using the same template and rules as the main command. - - - name: Neon Weekly Changelog Generator (help) - description: > - Print usage instructions for the changelog generator commands. - trigger: - command: generate:changelog:help - instructions: | - Print the following usage guide and then exit without creating files: - - Neon Weekly Changelog — Usage - -------------------------------- - 1) Next Friday draft (default) - - Run: generate:changelog - - Optional var: TIMEZONE=America/New_York - - 2) Specific date (backfill or special case) - - Run: generate:changelog:for - - Required var: TARGET_DATE=YYYY-MM-DD - - Output path pattern: - content/changelog/YYYY-MM-DD.md - - Notes: - - If a file already exists for the computed or specified date, no file is written. - - The template includes a collapsible "Fixes & improvements" section. diff --git a/.cursor/rules/neon-js-sdk-doc-sync.md b/.cursor/rules/neon-js-sdk-doc-sync.md deleted file mode 100644 index 4025c9732f..0000000000 --- a/.cursor/rules/neon-js-sdk-doc-sync.md +++ /dev/null @@ -1,390 +0,0 @@ -# Neon JavaScript SDK Documentation Sync - -## Purpose -This rule guides the process of reviewing merged PRs from the neon-js repository and updating the user-facing SDK documentation in the website repository to reflect API changes. - -## When to Apply -Apply this rule when asked to: -- "Review the latest neon-js PRs" -- "Update SDK docs from neon-js changes" -- "Sync JavaScript SDK documentation" -- "Check for SDK API changes" - -## Repositories - -### Source Repository (SDK Code) -- **Repo:** `neondatabase/neon-js` -- **URL:** https://github.com/neondatabase/neon-js -- **Access:** Use GitHub MCP tools to fetch PRs and file changes - -### Documentation Repository (This Repo) -- **Files to Update:** - - `content/docs/reference/javascript-sdk.md` - Main SDK reference documentation - - `content/docs/sdk-navigation.yaml` - Table of contents structure (if new methods added) - - `content/docs/auth/quick-start/nextjs.md` - Next.js with UI Components guide - - `content/docs/auth/quick-start/nextjs-api-only.md` - Next.js with API methods guide - - `public/llms/reference-javascript-sdk.txt` - Auto-generated during build, do not edit manually - -## Documentation Scope Decision Tree - -Before updating documentation, determine WHERE to document the change: - -### Client-Side SDK API Changes -**Target:** `content/docs/reference/javascript-sdk.md` -- New methods on `client.auth.*` or `client.from()` -- New client-side adapter methods -- Client-side query builders and filters -- Methods used in React components via hooks - -### Next.js Server-Side Features -**Target:** Next.js quickstart guides -- `content/docs/auth/quick-start/nextjs.md` (UI Components) -- `content/docs/auth/quick-start/nextjs-api-only.md` (API methods) - -Changes affecting: -- `neonAuth()` helper function -- `neonAuthMiddleware()` configuration -- `authApiHandler()` behavior -- Server-side environment variables -- Server-side performance optimizations -- `authServer.*` methods - -### Framework-Specific Guides -**Target:** Respective framework documentation -- React-specific features → React guides -- Next.js App Router features → Next.js guides -- Adapter changes → Integration guides - -### Example Mapping: -- ✅ New `client.auth.signIn.passkey()` → `javascript-sdk.md` -- ✅ New `NEON_AUTH_COOKIE_SECRET` env var → Next.js quickstart guides -- ✅ New middleware option → Next.js quickstart guides -- ✅ New React hook → React guide + SDK reference - -## Workflow - -### Step 1: Fetch Recent Merged PRs -Use the GitHub MCP tool to fetch merged PRs from the last 7 days: -``` -owner: neondatabase -repo: neon-js -state: closed (filter to merged only) -sort: updated -direction: desc -``` - -Ask user which time period if unclear (default: last 7 days). - -### Step 2: Review Each PR for User-Facing Changes - -For each PR, determine if it contains **user-facing API changes**: - -#### ✅ User-Facing Changes (DOCUMENT THESE) -- New authentication methods (e.g., `auth.signIn.social()`, `auth.signUp.email()`) -- New database query methods (e.g., `.select()`, `.insert()`, `.update()`) -- New filter methods (e.g., `.eq()`, `.gt()`, `.like()`) -- Changed method signatures (added/removed parameters) -- New adapters (e.g., BetterAuthReactAdapter, SupabaseAuthAdapter) -- New return types or response structures -- New configuration options in `createClient()` or `createAuthClient()` -- New Next.js middleware options or behavior -- New environment variables for server-side features -- Server-side performance optimizations (caching, etc.) -- Changes to server-side helper functions (`neonAuth()`, `authServer.*`) -- Deprecated methods (mark with deprecation note) -- Breaking changes to public API - -#### ❌ Internal Changes (DO NOT DOCUMENT) -- Refactoring internal code structure -- Performance optimizations that don't change API -- Bug fixes that don't change behavior -- Testing improvements -- Build system changes -- CI/CD pipeline updates -- Internal utility functions -- Type definitions that don't affect public API usage - -### Step 3: Analyze PR Changes - -For PRs with user-facing changes: - -1. **Read the PR description** - Understanding the "why" and intended use case -2. **Review changed files** - Focus on: - - `packages/*/src/**/*.ts` - Public API files - - `packages/*/README.md` - Usage examples - - `examples/**/*` - Example implementations -3. **Identify specific changes**: - - New exports - - Changed function signatures - - New parameters or options - - Modified return types - - New adapter methods - -### Step 4: Update SDK Documentation - -#### Main Documentation File -**Location:** `content/docs/reference/javascript-sdk.md` - -**Update patterns based on change type:** - -##### Adding a New Method -```markdown - - - -Brief description of what the method does. - -- Key behavior point 1 -- Key behavior point 2 -- Key behavior point 3 - -### Parameters - -
-View parameters - -| Parameter | Type | Required | -| -------------------- | ------------------- | -------- | -| paramName | string | ✓ | -| optionalParam | string \| undefined | | - -
- - - - -```typescript -const result = await client.auth.methodName({ - paramName: 'value', - optionalParam: 'optional value' -}) - -if (result.error) { - console.error('Error:', result.error.message) -} else { - console.log('Success:', result.data) -} -``` - - - -``` - -##### Updating an Existing Method -1. Locate the method by searching for its `id` attribute -2. Update the description if behavior changed -3. Update the parameters table if parameters changed -4. Update code examples if signature changed -5. Add notes about breaking changes if applicable - -##### Adding Multiple Code Examples -Use `CodeTabs` for multiple examples: -```markdown - - -```typescript -// Example 1 -``` - -```typescript -// Example 2 -``` - -```typescript -// Example 3 -``` - - -``` - -#### Navigation File (if needed) -**Location:** `content/docs/sdk-navigation.yaml` - -Update ONLY if adding entirely new methods. Add entries under appropriate section: - -```yaml -reference/javascript-sdk: - title: Neon Auth & Data API TypeScript SDKs - sections: - - section: Auth - items: - - title: New method name - id: unique-id-matching-markdown -``` - -**Section mappings:** -- `Getting Started` - Installation and initialization -- `Auth` - Authentication methods (`auth.signIn.*`, `auth.signUp.*`, etc.) -- `Database` - CRUD operations (`from()`, `.select()`, `.insert()`, etc.) -- `Filters` - Query filters (`.eq()`, `.gt()`, `.like()`, etc.) - -#### Next.js Quickstart Guides (Server-Side Features) -**Locations:** -- `content/docs/auth/quick-start/nextjs.md` - UI Components guide -- `content/docs/auth/quick-start/nextjs-api-only.md` - API methods guide - -**When to update:** -- New environment variables affecting Next.js -- Changes to `neonAuthMiddleware()` configuration -- New server-side helper methods -- Performance optimizations for server components -- Changes to API route handlers - -**Update patterns:** - -##### Adding Environment Variable Documentation -Locate the "Set up environment variables" step and add to the Admonition: -```markdown - -Add `ENV_VAR_NAME` to enable [feature description]. This [performance benefit or functionality]. - -[Technical details: TTL, validation, security notes] - -This feature is opt-in and fully backward compatible. Without this variable, [fallback behavior]. - -``` - -Update the code block to include the new variable: -```bash -NEON_AUTH_BASE_URL=https://... - -# Optional: Feature description (recommended for production) -NEW_ENV_VAR=example-value -``` - -##### Update frontmatter date: -```yaml -updatedOn: 'YYYY-MM-DDTHH:MM:SS.000Z' -``` - -### Step 5: Documentation Quality Standards - -Ensure all updates follow these standards: - -1. **Clarity** - Use clear, simple language -2. **Completeness** - Include all parameters and return types -3. **Examples** - Provide realistic, copy-paste ready examples -4. **Error Handling** - Show error handling patterns -5. **Consistency** - Match existing documentation style and voice -6. **Accuracy** - Verify against actual SDK code - -### Step 6: Create Summary - -After completing updates, provide a summary: - -```markdown -## SDK Documentation Updates from neon-js PRs - -### PRs Reviewed: [count] -- PR #X: [title] - User-facing: Yes/No - Scope: Client SDK / Next.js / Framework -- PR #Y: [title] - User-facing: Yes/No - Scope: Client SDK / Next.js / Framework - -### Documentation Changes Made: - -#### Client SDK Reference -1. **Added method**: `auth.newMethod()` - - File: content/docs/reference/javascript-sdk.md - - Section: Auth - -2. **Updated method**: `auth.existingMethod()` - - Changed: Added new optional parameter - - File: content/docs/reference/javascript-sdk.md - -3. **Updated navigation**: - - Added entry for new method - - File: content/docs/sdk-navigation.yaml - -#### Next.js Guides -1. **Added configuration**: `NEON_AUTH_COOKIE_SECRET` - - Files: - - content/docs/auth/quick-start/nextjs.md - - content/docs/auth/quick-start/nextjs-api-only.md - - Section: Environment variables - -#### Framework Guides -1. **Updated guide**: [Framework name] - - File: content/docs/[path] - - Change: [description] - -### No Documentation Changes Needed: -- PR #Z: Internal refactoring only -``` - -## Important Notes - -### What NOT to Update -- **LLM text file** (`public/llms/reference-javascript-sdk.txt`) - This is auto-generated during build -- **Internal documentation** - Focus only on user-facing SDK reference -- **Tutorial pages** - Only update the reference documentation unless specifically asked - -### Multiple Guides May Need Updates -Some changes affect multiple documentation files: -- New auth method might need updates in SDK reference AND framework guides -- Environment variable changes might need updates in multiple quickstart guides -- Always check if related guides need updates for consistency - -### Method ID Conventions -- Use kebab-case: `auth-signinwithpassword` -- Be descriptive: `auth-sendverificationotp` -- Match the method purpose, not just the function name - -### Code Example Standards -- Use TypeScript for all examples -- Show full import statements in first example -- Include error handling with `if (result.error)` -- Use realistic variable names -- Keep examples concise but complete - -### Breaking Changes -If a PR introduces breaking changes: -1. Add an `Admonition` component with type "important" -2. Clearly describe what changed -3. Provide migration example (old → new) - -Example: -```markdown - -The `auth.signIn()` method signature has changed. The `rememberMe` parameter is now part of the options object. - -**Before:** -```typescript -await auth.signIn(email, password, true) -``` - -**After:** -```typescript -await auth.signIn.email({ email, password, rememberMe: true }) -``` - -``` - -## Execution Checklist - -When syncing documentation: -- [ ] Fetch merged PRs from neon-js repo -- [ ] Review each PR description and changes -- [ ] Identify user-facing changes only -- [ ] Determine documentation scope (Client SDK vs Next.js vs Framework) -- [ ] Update `javascript-sdk.md` with new/changed client methods (if applicable) -- [ ] Update `sdk-navigation.yaml` if new methods added (if applicable) -- [ ] Update Next.js quickstart guides for server-side changes (if applicable) -- [ ] Update framework-specific guides as needed (if applicable) -- [ ] Follow appropriate component patterns (TwoColumnLayout, Admonition, etc.) -- [ ] Include code examples for all changes -- [ ] Verify parameter tables are complete -- [ ] Update frontmatter dates on modified files -- [ ] Check for breaking changes and document appropriately -- [ ] Create summary of changes made -- [ ] Test locally with `npm run dev` (if requested) - -## Example Usage - -**User request:** -> "Review the latest PRs from neon-js and update the SDK docs" - -**Your response:** -1. Fetch last 7 days of merged PRs from neondatabase/neon-js -2. List PRs found with brief description -3. Analyze each for user-facing changes -4. Update documentation files as needed -5. Provide summary of changes made From 2bdef5a5f9d6c5ab8d5dc2098ee0d1c2ed4aed63 Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 31 Jan 2026 11:13:24 -0400 Subject: [PATCH 8/9] chore: restore neon-changelog.rules --- .cursor/neon-changelog.rules | 145 +++++++++++++++++++++++++++++++++++ 1 file changed, 145 insertions(+) create mode 100644 .cursor/neon-changelog.rules diff --git a/.cursor/neon-changelog.rules b/.cursor/neon-changelog.rules new file mode 100644 index 0000000000..33e476a357 --- /dev/null +++ b/.cursor/neon-changelog.rules @@ -0,0 +1,145 @@ +rules: + - name: Neon Weekly Changelog Generator (next Friday) + description: > + Create the Neon weekly changelog for the next upcoming Friday (from now). + Writes content/changelog/YYYY-MM-DD.md with a consistent structure. + trigger: + command: generate:changelog + variables: + - key: TIMEZONE + default: America/New_York + description: IANA timezone used to compute "now" and next Friday. + instructions: | + You are generating a Neon weekly changelog file. + + ## Date logic (MUST DO) + - Use the IANA timezone in `${TIMEZONE}` (default America/New_York). + - Compute **next upcoming Friday** from the current moment in `${TIMEZONE}`: + - Let `today` be the current date in `${TIMEZONE}`. + - Let `dow` be Sunday=0 … Friday=5. + - `delta = (5 - dow + 7) % 7` + - If `delta === 0`, treat **today as Friday** and select **Friday of next week** (`add=7`) so drafts created on a Friday always target the *next* release. Otherwise `add=delta`. + - `target = today + add days` + - Format `target` as `YYYY-MM-DD` → `CHANGELOG_DATE`. + - Paths: + - `DEST_DIR = content/changelog` + - `FILENAME = ${CHANGELOG_DATE}.md` + - `DEST_PATH = ${DEST_DIR}/${FILENAME}` + + ## File rules + - If `${DEST_PATH}` already exists: STOP and report that the changelog file already exists. Do not overwrite. + - Otherwise, create `${DEST_PATH}` with the template below. + + ## Voice & content guidelines + - Friendly, concise, user-focused; sentence-style capitalization. + - Use H2 (`##`) for top-level sections. + - Feature headings should communicate user value, not just internal names. + - Each feature description: 1–3 sentences. + - Include optional image blocks where relevant. + - Always include a **Fixes & improvements** section as a collapsible `
`. + - **IMPORTANT**: Use only placeholder content (Lorem ipsum) and generic headings like "## New feature" - DO NOT create fictional features, improvements, or specific content. + + ## Markdown template (write exactly this shape, replacing bracketed placeholders) + --- + title: [Concise main theme of the release] + --- + + ## New feature + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. + + ## Another feature + + Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. + + ## Third feature + + Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. + +
+ **Fixes & improvements** + + - [Short bullet describing a fix or improvement.] + - [Another short bullet, if applicable.] + +
+ + ## Output requirements + - Save the file to `${DEST_PATH}` with the above content. + - After creation, print: + - `CHANGELOG_DATE` + - `DEST_PATH` + - A checklist of any `[placeholders]` still present. + + notes: | + # How to use (documentation only; safe to keep in rules) + - **Create next Friday’s draft (typical):** + - Run: `generate:changelog` + - Optional: set `TIMEZONE` (default `America/New_York`). + - **Create for a specific date (backfill / special case):** + - Run: `generate:changelog:for` with `TARGET_DATE=YYYY-MM-DD`. + - **Show usage help:** + - Run: `generate:changelog:help` + + ### Helper (JS) — compute next Friday in a specific timezone (no external deps) + ```js + function nextFriday(tz = "America/New_York") { + const now = new Date(); + const fmt = new Intl.DateTimeFormat('en-CA', { + timeZone: tz, year: 'numeric', month: '2-digit', day: '2-digit', weekday: 'short' + }); + const parts = Object.fromEntries(fmt.formatToParts(now).map(p => [p.type, p.value])); + const base = new Date(`${parts.year}-${parts.month}-${parts.day}T00:00:00`); + const dow = base.getDay(); // 0..6 + const delta = (5 - dow + 7) % 7; // 5 = Friday + const add = (delta === 0 ? 7 : delta); + const friday = new Date(base.getTime() + add * 86400000); + const y = friday.getFullYear(); + const m = String(friday.getMonth() + 1).padStart(2, '0'); + const d = String(friday.getDate()).padStart(2, '0'); + return `${y}-${m}-${d}`; + } + ``` + + - name: Neon Weekly Changelog Generator (override date) + description: > + Create a Neon changelog for a specific date (YYYY-MM-DD) when you need to + backfill or pre-create a non-standard week. + trigger: + command: generate:changelog:for + variables: + - key: TARGET_DATE + description: Date string in YYYY-MM-DD (must be a valid calendar date). + instructions: | + - Validate `${TARGET_DATE}` is a valid `YYYY-MM-DD`. + - Use `${TARGET_DATE}` as `CHANGELOG_DATE`. + - Set: + - `DEST_DIR = content/changelog` + - `FILENAME = ${CHANGELOG_DATE}.md` + - `DEST_PATH = ${DEST_DIR}/${FILENAME}` + - If the file exists, STOP and report; otherwise create it using the same template and rules as the main command. + + - name: Neon Weekly Changelog Generator (help) + description: > + Print usage instructions for the changelog generator commands. + trigger: + command: generate:changelog:help + instructions: | + Print the following usage guide and then exit without creating files: + + Neon Weekly Changelog — Usage + -------------------------------- + 1) Next Friday draft (default) + - Run: generate:changelog + - Optional var: TIMEZONE=America/New_York + + 2) Specific date (backfill or special case) + - Run: generate:changelog:for + - Required var: TARGET_DATE=YYYY-MM-DD + + Output path pattern: + content/changelog/YYYY-MM-DD.md + + Notes: + - If a file already exists for the computed or specified date, no file is written. + - The template includes a collapsible “Fixes & improvements” section. From 71ec7ec71fd24e9913146c7b25c07f549f9d598d Mon Sep 17 00:00:00 2001 From: Daniel Price Date: Sat, 31 Jan 2026 11:58:39 -0400 Subject: [PATCH 9/9] fix: resolve merge conflicts, align with main --- content/docs/auth/quick-start/nextjs-api-only.md | 4 ---- content/docs/auth/quick-start/nextjs.md | 4 ---- 2 files changed, 8 deletions(-) diff --git a/content/docs/auth/quick-start/nextjs-api-only.md b/content/docs/auth/quick-start/nextjs-api-only.md index cd47f68f3b..24dd5ab375 100644 --- a/content/docs/auth/quick-start/nextjs-api-only.md +++ b/content/docs/auth/quick-start/nextjs-api-only.md @@ -2,11 +2,7 @@ title: Use Neon Auth with Next.js (API methods) subtitle: Build your own auth UI using SDK methods enableTableOfContents: true -<<<<<<< HEAD updatedOn: '2026-01-30T14:03:06.272Z' -======= -updatedOn: '2026-01-24T00:00:00.000Z' ->>>>>>> dc48e230d (docs: document Next.js session caching configuration) layout: wide --- diff --git a/content/docs/auth/quick-start/nextjs.md b/content/docs/auth/quick-start/nextjs.md index 679ea72152..2abce1185f 100644 --- a/content/docs/auth/quick-start/nextjs.md +++ b/content/docs/auth/quick-start/nextjs.md @@ -2,11 +2,7 @@ title: Use Neon Auth with Next.js (UI Components) subtitle: Set up authentication in Next.js using pre-built UI components enableTableOfContents: true -<<<<<<< HEAD updatedOn: '2026-01-30T14:03:06.274Z' -======= -updatedOn: '2026-01-24T00:00:00.000Z' ->>>>>>> dc48e230d (docs: document Next.js session caching configuration) layout: wide ---