Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@suhasdeshpande
Copy link
Contributor

@suhasdeshpande suhasdeshpande commented Sep 17, 2025

Summary by CodeRabbit

  • Documentation
    • Updated Storage Quick Start examples to consistently use ID-based file generation across client and server samples.
    • Clarified client and Node.js snippets to match their respective SDK usage.
    • Removed a browser-specific create-file snippet to streamline the multi-language examples and reduce duplication.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Sep 17, 2025

Walkthrough

The docs file src/routes/docs/products/storage/quick-start/+page.markdoc was updated: the client-web create-file example now imports ID from "appwrite" and uses it for fileId; the server-nodejs example uses the module alias sdk.ID.unique() for fileId; a browser-specific snippet that created a File directly was removed. No other functional changes were made to code blocks or flow.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title "Add ID import to storage quick start examples" is concise and accurately reflects the main change in the PR—adding the ID import and updating the storage quick-start examples as described in the summary. It communicates the primary intent clearly and is appropriate for someone scanning the repository history.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch suhas/fix-doc

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a2d71fb and 0cb120f.

📒 Files selected for processing (1)
  • src/routes/docs/products/storage/quick-start/+page.markdoc (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/routes/docs/products/storage/quick-start/+page.markdoc
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build
  • GitHub Check: tests

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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Nitpick comments (3)
src/routes/docs/products/storage/quick-start/+page.markdoc (3)

49-53: Standardize Cloud endpoint to include region.

Other examples use https://.cloud.appwrite.io/v1. Align Node sample for consistency and fewer 301/geo issues.

Apply this diff:

-    .setEndpoint('https://cloud.appwrite.io/v1')
+    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1')

113-116: Android: import Context (used below).

Apply this diff:

 import io.appwrite.Client
 import io.appwrite.services.Storage
 import io.appwrite.ID
+import android.content.Context

226-228: Flutter download: add missing semicolon after writeAsBytesSync.

Small syntax fix.

Apply this diff:

-    file.writeAsBytesSync(bytes)
+    file.writeAsBytesSync(bytes);

Additionally, add import 'dart:io'; at the top of this snippet so File resolves.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c176f80 and a2d71fb.

📒 Files selected for processing (1)
  • src/routes/docs/products/storage/quick-start/+page.markdoc (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: build
  • GitHub Check: tests
🔇 Additional comments (4)
src/routes/docs/products/storage/quick-start/+page.markdoc (4)

23-23: Good call adding ID import to web example.

Makes the ID.unique() usage explicit and copy‑pasteable.


94-110: Swift sample looks correct.

API usage and async/await are consistent.


159-180: HTTP multipart example: LGTM.

Headers, operations/map, and file part look correct.


303-306: React Native download: object-params confirmed — no change required.

Appwrite React Native docs use an object signature for Storage.getFileDownload (bucketId, fileId, optional token); the snippet in src/routes/docs/products/storage/quick-start/+page.markdoc lines 303–306 already matches.

@ChiragAgg5k ChiragAgg5k merged commit b18407b into main Oct 24, 2025
6 of 7 checks passed
@ChiragAgg5k ChiragAgg5k deleted the suhas/fix-doc branch October 24, 2025 02:56
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.

3 participants