Refresh Auto Drive S3 docs and add rclone guide#95
Open
EmilFattakhov wants to merge 8 commits into
Open
Conversation
Refresh pages/sdk/auto-drive/s3_layer.mdx for the rclone S3 Compatibility milestone (autonomys/auto-drive#4): bucket support and ListBuckets, ListObjectsV2 with prefix/delimiter/pagination, MD5 ETags with CID exposed via x-amz-meta-cid, DeleteObject 403 by design, AWS CLI compatibility, and the new /s3 endpoint path. Document the @autonomys/file-server S3 helpers added in autonomys/auto-sdk#535 for developers building their own S3-compatible layers. Add pages/sdk/auto-drive/rclone.mdx as a dedicated rclone guide alongside the S3 layer page, covering quickstart, full config reference, supported commands, workflows (archival, cron, mount, migration, CI/CD, Docker), and troubleshooting. Wire it into _meta.js under the S3 Layer entry. Co-authored-by: Cursor <cursoragent@cursor.com>
- s3_layer: scope MD5 ETag claim to post-feature objects and document the legacy fallback (no ETag header on HEAD/GET; CID-wrapped ETag in ListObjectsV2). - s3_layer: present forcePathStyle as a working configuration rather than a requirement, and document the bucketEndpoint style used by upstream backend integration tests. - s3_layer: note the 1,000 hard cap clamp on max-keys. - rclone: restore the full two-sentence 403 delete error message in both the unsupported-commands list and the troubleshooting example. Co-authored-by: Cursor <cursoragent@cursor.com>
✅ Deploy Preview for autonomysdevdocs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
… sections by default These sections are reference material rather than primary developer flows, so collapse them in the sidebar by default to keep Auto Drive and Auto SDK visually prominent. Co-authored-by: Cursor <cursoragent@cursor.com>
EmilFattakhov
force-pushed
the
docs/auto-drive-s3-rclone-update
branch
from
36fe6a3 to
f96195c
Compare
Member
Author
|
LLMs are doing a terrific job, a lot of information is also pulled from your rclone docs @jim-counter :) |
Move Pay with AI3 to the fourth slot followed by the S3 Layer page so the most discoverable surfaces (paid uploads and S3 compatibility) appear immediately after the introductory pages. Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
jim-counter
requested changes
May 29, 2026
Member
jim-counter
left a comment
jim-counter
left a comment
There was a problem hiding this comment.
Originally I was going to ask if we could split the S3 and rclone updates into two separate PRs but after reflecting I can't see the harm.
Note that rclone has not been tested yet and we will be seeking approval to be an officially supported backend which will likely require a docs update later on.
Co-authored-by: Jim Counter <jimcounter@hotmail.com>
- Relocate the rclone page from Auto SDK -> Auto Drive (pages/sdk/auto-drive/rclone.mdx -> pages/auto_drive/rclone.mdx). rclone is a tool-level integration of Auto Drive's S3 layer rather than an Auto SDK surface, so it belongs in the top-level Auto Drive section alongside Overview and Pay with AI3. - Update the two _meta.js sidebars accordingly (drop from sdk/auto-drive, add to auto_drive). - Fix cross-links: s3_layer.mdx now links to /auto_drive/rclone, and the rclone page links back to /sdk/auto-drive/s3_layer. - Add a `rclone hashsum md5` example to the md5sum/check/hashsum section and note that md5sum is shorthand for `hashsum md5` and that only md5 is supported (Auto Drive stores MD5 ETags). Co-authored-by: Cursor <cursoragent@cursor.com>
Co-authored-by: Cursor <cursoragent@cursor.com>
EmilFattakhov
commented
May 29, 2026
Member
Author
EmilFattakhov
left a comment
EmilFattakhov
left a comment
There was a problem hiding this comment.
Thanks for the review @jim-counter, all comments addressed
jim-counter
requested changes
Jun 1, 2026
Member
jim-counter
left a comment
jim-counter
left a comment
There was a problem hiding this comment.
Thanks for the changes. One more required please.
|
|
||
| ```bash | ||
| rclone md5sum autodrive:my-archive/ | ||
| rclone hashsum md5 autodrive:my-archive/ |
Member
There was a problem hiding this comment.
Should be below check to match the heading.
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.
Summary
pages/sdk/auto-drive/s3_layer.mdxagainst the current backend: virtual buckets, ListObjectsV2 with sentinel-token continuation, MD5 ETags +x-amz-meta-cid, multipart, range, immutability (403 on delete), and the@autonomys/file-serverserver-side helpers.pages/sdk/auto-drive/rclone.mdx— quickstart, full config, supported/unsupported commands, workflows (cron / GitHub Actions / GitLab CI / docker-compose), and troubleshooting (legacy-object MD5, 403 on delete, auth)._meta.js.forcePathStyle: trueas a working option (not "required") and documents thebucketEndpointstyle used by upstream tests; notes the 1,000 hard cap clamp onmax-keys; restores the full two-sentence 403 delete error.