docs: revamp the attachment documentation #289
Conversation
| --- | ||
| title: "Attachments / Files" | ||
| description: Syncing large attachments/files directly using PowerSync is not recommended. | ||
| description: Keep files out of your database and handle attachments in an entirely storage-agnostic way. PowerSync syncs minimal metadata while an offline-first queue automatically handles uploads, downloads, and retries. |
There was a problem hiding this comment.
I don't think we should say "offline-first". Perhaps just "offline"?
There was a problem hiding this comment.
That would make the Queue offline which is not the case. "Offline-first" here means that it's still going to behave fine offline and would automatically sync when back online just like how the rest of PowerSync does.
stevensJourney
left a comment
stevensJourney
left a comment
There was a problem hiding this comment.
I left some minor comments, overall this doc is looks very well written and is a good guide for Attachments.
…tachment types using single and multiple queues
|
|
||
| ### Custom Storage Adapters | ||
|
|
||
| Create adapters for other storage systems: |
There was a problem hiding this comment.
It would be helpful if we can define "other" here - is it other to any of the examples we mention in the relevant sections above?
There was a problem hiding this comment.
Good catch! I have updated that section.
Context
This PR revamps the PowerSync attachments documentation to provide clearer, more structured and consistent guidance for developers implementing file handling across all supported platforms.
Notable Changes
TODOs
Code Examples:
Content Review:
Related PR implementation: powersync-ja/powersync-js#735