Skip to content

Conversation

@adityaoberai
Copy link
Member

@adityaoberai adityaoberai commented Jan 19, 2026

What does this PR do?

Add docs page for Screenshots API

Test Plan

Visit /docs/products/avatars/screenshots

Related PRs and Issues

appwrite/appwrite#10675

Have you read the Contributing Guidelines on issues?

Yes

Summary by CodeRabbit

  • Documentation
    • Added a new "Screenshots" guide under Avatars with parameter tables, use cases, and multi-language code samples (web, Flutter, Apple, Android, React Native).
  • Blog
    • Published an announcement post introducing the Screenshots API and usage workflow.
  • Changelog
    • Added an entry summarizing Screenshots API features and production usage notes.
  • Navigation
    • Added a documentation card and navigation entry for the new Screenshots guide, marked as new.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Jan 19, 2026

Walkthrough

Imported isNewUntil('28 Feb 2026') in the Avatars docs layout and added a "Screenshots" navigation item under Concepts > Favicons whose new status is determined by that import. Added a docs card linking to /docs/products/avatars/screenshots. Created src/routes/docs/products/avatars/screenshots/+page.markdoc documenting Avatars.getScreenshot (parameters, viewport/browser/geolocation options, permissions, wait time, use cases, and multi-language code samples). Added a blog post announcing the Screenshots API and a changelog entry dated 2026-01-20.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 3
✅ 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 screenshots API docs + blog' accurately summarizes the main changes: adding documentation and a blog post for the Screenshots API feature.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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: 1

🤖 Fix all issues with AI agents
In `@src/routes/docs/products/avatars/screenshots/`+page.markdoc:
- Line 257: Replace the incorrect enum name Timezone.EuropeParisAppwrite with
the correct Timezone.EuropeParis on the line that currently sets timezone:
Timezone.EuropeParisAppwrite; update that single occurrence so it matches the
other PascalCase timezone enums (e.g., Timezone.EuropeLondon,
Timezone.AsiaTokyo) and preserves the existing casing and punctuation.
🧹 Nitpick comments (2)
src/routes/docs/products/avatars/screenshots/+page.markdoc (2)

106-106: Inconsistent boolean parameter documentation.

The fullpage and touch parameters are described using 1/0 values, but the code examples throughout the document use true/false (e.g., fullpage: true on line 150, touch: true on line 269). Update the descriptions to use true/false for consistency with the examples.

📝 Suggested fix
-| fullpage | boolean | Capture the full scrollable page (`1`) or only the viewport (`0`). Defaults to `false` if not provided. |
+| fullpage | boolean | Capture the full scrollable page (`true`) or only the viewport (`false`). Defaults to `false` if not provided. |
-| touch | boolean | Enable touch device support (`1`) or disable it (`0`). Defaults to `false` if not provided. |
+| touch | boolean | Enable touch device support (`true`) or disable it (`false`). Defaults to `false` if not provided. |

Also applies to: 112-112


124-237: Missing React Native example in viewport customization section.

The initial code example (lines 76-90) includes client-react-native, but this section omits it. Consider adding React Native examples for consistency, or document that subsequent examples focus on a subset of SDKs.

@adityaoberai adityaoberai changed the title Add screenshots API docs Add screenshots API docs + blog Jan 20, 2026
adityaoberai and others added 6 commits January 21, 2026 18:00
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
Co-authored-by: Atharva Deosthale <atharva.deosthale17@gmail.com>
@adityaoberai adityaoberai merged commit a3c53c4 into main Jan 21, 2026
18 of 21 checks passed
@adityaoberai adityaoberai deleted the add-screenshots-api-docs branch January 21, 2026 14:05
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.

4 participants