docs(repo): ship per-package AGENTS.md and migrations via npm#2397
Merged
Conversation
@supabase/auth-js
@supabase/functions-js
@supabase/postgrest-js
@supabase/realtime-js
@supabase/storage-js
@supabase/supabase-js
commit: |
o-santi
approved these changes
May 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Establishes a per-package agent-discoverability layer that ships via npm:
@supabase/*core package now hasAGENTS.md+migrations/at its root, included in thefilesarray. Afternpm install @supabase/<package>, agents find a pointer file directing them to the package's TSDoc-annotatedsrc/(canonical, version-pinned API docs) and migration notes — no duplication of docs-site content.AGENTS.mdis the vendor-neutral entry point (alongside.claude/CLAUDE.mdand.cursor/.cursorrules), explaining the workspace layout and pointing agents at the centralized Supabase agent skills (npx skills add supabase/agent-skills) for higher-level guidance.docs/MIGRATION.mdis stripped of ~500 lines of stale 8-month-old monorepo-restructure content; what remains is genuine cross-cutting migration notes (currently just the Node 18 → 20 drop), one H2 per theme. The matching obsolete "Repository Structure Changed" callouts inREADME.mdandCONTRIBUTING.mdare removed.No code changes. Verified via
npm pack --dry-runthatAGENTS.mdandmigrations/ship in all six core package tarballs.