docs: `Working with Files`

[juliusmarminge]

https://docs-uploadthing-git-working-with-files-pinglabs.vercel.app/working-with-files

I think we should have more generic text-based docs (examples and docs that gets straight to the code are great in their way, but I think we should also explain the concepts)

Pages I think could be useful

• Uploading Files
  • Explain what different ways there are
  • [ ] Client uploads
    • Setup an api route on your server using an adapter
    • Use uploadthing/client.genUploader, client-lib hooks etc
    • File never touches your server
  • [ ] Server uploads
    • Submit file to your server, then upload from there
  • might be easier to explain once/if we merge prepareUpload and uploadFiles API endpoints and there's only one way to retrieve the presigned URLs
  • Pre-upload operations? Where can you crop, compress images? Optimize files before upload? Verify file data? Blur hashes? Etc etc.
• Working with files
  • [x] This PR mostly goes over accessing your files
  • [ ] Streaming files?
  • [ ] Do some operation need more concept-type-docs than just a link to the UTApi method on the API reference page?
  • [ ] Replacing files? Right now we recommend just deleting the old file in onUploadComplete. Should this be documented? Or just implement the override functionality on infra side?

By having more concept type-thing, it'd be easier to make 3rd party SDKs for different langauges (Python, Go etc) and help adoption of non-JS devs to use UploadThing

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docs-uploadthing	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 21, 2024 9:00pm

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 58351d887d1fdb11b43273b3334b4db1e90bf551

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions[bot]]

A new canary is available for testing. You can install this latest build in your project with:

pnpm add @uploadthing/dropzone@0.4.2-canary.b720c87
pnpm add @uploadthing/mime-types@0.2.11-canary.b720c87
pnpm add @uploadthing/nuxt@6.5.6-canary.b720c87
pnpm add @uploadthing/react@6.5.5-canary.b720c87
pnpm add @uploadthing/shared@6.7.5-canary.b720c87
pnpm add @uploadthing/solid@6.4.5-canary.b720c87
pnpm add @uploadthing/svelte@6.5.5-canary.b720c87
pnpm add uploadthing@6.10.5-canary.b720c87
pnpm add @uploadthing/vue@6.5.5-canary.b720c87