Skip to content

Point neon init doc links at canonical neon.com/docs pages - #434

Open
philip wants to merge 1 commit into
mainfrom
docs/init-canonical-doc-urls
Open

Point neon init doc links at canonical neon.com/docs pages#434
philip wants to merge 1 commit into
mainfrom
docs/init-canonical-doc-urls

Conversation

@philip

@philip philip commented Aug 14, 2026

Copy link
Copy Markdown
Contributor

Overview

neon init surfaced documentation hints (the prerequisite and context fields agents follow) using the old /docs/ai/skills/neon-postgres/references/*.md skill files. Those pages were retired and now only redirect, so this points them at the canonical docs directly: getting started, connection methods, Neon Auth, the serverless driver, the CLI, branching, and the JS SDK.

It also renames the map and its emitted field from skillReferences to docReferences. These are documentation links, not the agent skill files installed by the skills CLI, so the old name implied a connection that does not exist. The emitted-field rename is a small change to the agent protocol output.

Verified all eight new URLs resolve (200) and the old ones 308-redirect onto live pages, so this removes a redirect hop.

Split out of #431 so the doc-link update is easy to review on its own.

This pull request and its description were written by Isaac.

The init flow surfaced documentation hints (prerequisite/context) using
the old /docs/ai/skills/neon-postgres/references/*.md skill files, which
were retired and now only redirect. Point them at the canonical pages
directly: getting started, connection methods, Neon Auth, the serverless
driver, the CLI, and the rest.

Also rename the map and its emitted field from skillReferences to
docReferences: these are documentation links, not the agent skill files
installed by the skills CLI, and the old name implied a connection that
does not exist.

Co-authored-by: Isaac
@philip
philip force-pushed the docs/init-canonical-doc-urls branch from 22af5ba to e1946a5 Compare August 14, 2026 13:17
@philip
philip requested review from andrelandgraf and a lite review from Copilot August 24, 2026 21:43

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates neon init to use canonical Neon documentation URLs and renames its emitted documentation field.

Changes:

  • Replaces retired skill-reference URLs.
  • Renames skillReferences to docReferences.
  • Updates tests, snapshots, and adds a patch changeset.

Blocking findings:

  • .changeset/init-canonical-doc-urls.mdCritical, 1 vote: preserve skillReferences as a compatibility alias or treat this as a breaking protocol change with appropriate versioning.
  • packages/cli/src/init/phases/skills.tsCritical, 2 votes: existing agents may silently lose documentation links when the field is removed.

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.

Show a summary per file
File Summary
packages/cli/src/init/skills.ts Defines canonical documentation URLs.
packages/cli/src/init/skills.test.ts Tests documentation URL mappings.
packages/cli/src/init/phases/skills.ts Emits docReferences.
packages/cli/src/init/phases/neon_auth.ts Updates the Neon Auth link.
packages/cli/src/init/phases/getting_started.ts Updates the getting-started link.
packages/cli/src/init/phases/getting_started.test.ts Updates prerequisite assertions.
packages/cli/src/init/phases/db.ts Updates the connection-method link.
packages/cli/src/init/phases/db.test.ts Updates prerequisite assertions.
packages/cli/src/init/__snapshots__/agent_snapshot.test.ts.snap Refreshes protocol snapshots.
.changeset/init-canonical-doc-urls.md Documents the CLI patch release.
Suppressed comments (1)

packages/cli/src/init/skills.test.ts:24

  • This test only asserts the getting-started URL exactly; for the other seven it checks only the host and .md suffix. The snapshots do not catch wrong values because they are generated from DOC_REFERENCE_URLS itself, so a typo in any other canonical path would pass. Assert the expected key-to-URL mapping exactly for every entry.
		for (const key of expectedKeys) {
			expect(DOC_REFERENCE_URLS).toHaveProperty(key);
			expect(DOC_REFERENCE_URLS[key]).toMatch(/^https:\/\/neon\.com\//);

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@@ -0,0 +1,5 @@
---
"neon": patch
},
},
skillReferences: SKILL_REFERENCE_URLS,
docReferences: DOC_REFERENCE_URLS,
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants