Skip to content

docs: update all docs to reflect beta API changes#183

Open
abhay-ramesh wants to merge 1 commit intobetafrom
feat/docs-beta-api-updates
Open

docs: update all docs to reflect beta API changes#183
abhay-ramesh wants to merge 1 commit intobetafrom
feat/docs-beta-api-updates

Conversation

@abhay-ramesh
Copy link
Copy Markdown
Owner

Summary

Updated all 45 MDX documentation files to match the new API landing in the beta branch. No old examples remain.

Changes applied everywhere

Old New
const { s3 } = build() const { upload } = build()
s3.file(), s3.image(), s3.createRouter() upload.file(), upload.image(), upload.createRouter()
.maxFileSize('10MB') .maxSize('10MB')
.types(['image/jpeg']) .accept(['image/jpeg'])
.extensions(['.pdf']) .accept(['.pdf'])
.formats(['jpeg', 'png']) .accept(['image/jpeg', 'image/png'])
.onUploadComplete(hook) .onComplete(hook)
.onUploadStart(hook) .onStart(hook)
.onUploadError(hook) .onError(hook)
{ file, key, url } in hooks { file, storagePath, publicUrl, presignedUrl }
const upload = createUploadClient(...) const { upload, useUpload } = createUploadClient(...)
useUploadRoute useUpload (preferred), useUploadRoute noted for compat
AppS3Router AppRouter

Also added mentions of new presets (upload.video(), upload.audio(), upload.document()) where relevant.

Files updated

All 45 docs files: quick-start, manual-setup, all API reference pages, all guides, all 17 integration pages, all 6 provider pages.

🤖 Generated with Claude Code

Applied across all 45 MDX files (integrations, guides, api reference,
providers, quick-start, etc.):

- s3.* → upload.* (provider-neutral: s3.file, s3.image, s3.createRouter)
- .maxFileSize() → .maxSize()
- .types([]) / .extensions([]) / .formats([]) → .accept()
- onUploadComplete / onUploadStart / onUploadError → onComplete / onStart / onError
- { key, url } in hook callbacks → { storagePath, publicUrl, presignedUrl }
- const { s3 } = build() → const { upload } = build()
- createUploadClient<AppRouter>() → const { upload, useUpload } = createUploadClient<AppRouter>()
- useUploadRoute → useUpload (shown as preferred)
- AppS3Router → AppRouter
- Added upload.video(), upload.audio(), upload.document() presets where relevant

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@vercel
Copy link
Copy Markdown
Contributor

vercel Bot commented Mar 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
pushduck Ready Ready Preview, Comment Mar 11, 2026 9:26pm

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 11, 2026

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 0e40ee25-735f-47f1-bab5-92071da17a9d

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/docs-beta-api-updates

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

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.

1 participant