Update Appwrite description to include Sites, add MCP to products list#9867
Update Appwrite description to include Sites, add MCP to products list#9867
Conversation
ebenezerdon
requested review from
LauraDuRy,
TorstenDittmann,
christyjacob4 and
stnguyen90
WalkthroughThe README.md and README-CN.md files were updated to expand the Appwrite platform description, consolidate links, correct a Table of Contents anchor, clean whitespace, and add two new product entries: MCP and Sites. These changes are documentation-only with no modifications to code, SDKs, or architecture. Changes
Poem
Note ⚡️ AI Code Reviews for VS Code, Cursor, WindsurfCodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback. 📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (20)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
Security Scan Results for PRDocker Image Scan Results
Source Code Scan Results🎉 No vulnerabilities found! |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Setup & Build Appwrite Image
- GitHub Check: scan
- GitHub Check: Setup & Build Appwrite Image
🔇 Additional comments (7)
README.md (7)
1-1: Consolidated header links improve readability.Merging the two top-level links into a single blockquote makes the welcome banner cleaner and keeps key calls-to-action grouped together.
27-27: Project description updated to emphasize full-stack platform.The new wording accurately shifts “backend server” to “end-to-end platform” and highlights the integrated hosting solution. This aligns with the PR’s goal of reflecting Appwrite’s scope.
131-131: Whitespace-only adjustment around the Gitpod integration logo; no action needed.
137-137: Whitespace-only adjustment around the Akamai Compute integration logo; no action needed.
143-143: Whitespace-only adjustment around the AWS Marketplace integration logo; no action needed.
189-189: MCP entry added correctly.The new MCP product link and description succinctly communicate its purpose. Link path and formatting look good.
190-190: Sites entry added correctly.The Sites product is clearly described, and the link targets the appropriate documentation.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
README-CN.md (1)
183-183: 建议优化“站点”描述的流畅度
当前描述“直接从 Appwrite 开发、部署和扩展您的 Web 应用程序，与您的后端一起。”可酌情改为：直接在 Appwrite 中开发、部署并与后端服务无缝集成您的 Web 应用程序
以提升可读性和表达准确性。
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README-CN.md(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
- GitHub Check: E2E Service Test (Migrations)
- GitHub Check: E2E Service Test (Webhooks)
- GitHub Check: E2E Service Test (Teams)
- GitHub Check: E2E Service Test (Messaging)
- GitHub Check: E2E Service Test (Sites)
- GitHub Check: E2E Service Test (Proxy)
- GitHub Check: E2E Service Test (FunctionsSchedule)
- GitHub Check: E2E Service Test (Projects)
- GitHub Check: E2E Service Test (GraphQL)
- GitHub Check: E2E Service Test (Functions)
- GitHub Check: E2E Service Test (Locale)
- GitHub Check: E2E Service Test (Avatars)
- GitHub Check: E2E Service Test (Account)
- GitHub Check: E2E Service Test (Databases)
- GitHub Check: E2E Service Test (Dev Keys)
- GitHub Check: Unit Test
- GitHub Check: E2E General Test
- GitHub Check: Benchmark
- GitHub Check: scan
🔇 Additional comments (2)
README-CN.md (2)
29-29: 文档精准度：引言段落更新
中文翻译准确地反映了英文版本中新增的“完全集成托管解决方案”内容，语义清晰，风格一致。
182-182:Details
✅ Verification successful
请验证 MCP 文档链接
请确认该链接在中文站点是否有效，且路径是否与英文 README 中保持一致（docs/tooling/mcpvsdocs/products/mcp）。
🏁 Script executed:
#!/bin/bash # 验证 MCP 文档链接是否返回 200 状态码 curl -s -o /dev/null -w "%{http_code}" https://appwrite.io/docs/tooling/mcpLength of output: 81
🏁 Script executed:
#!/bin/bash # Search for the MCP link in the English README echo "MCP link occurrences in README.md:" rg -n "docs.*mcp" README.md # Verify that https://appwrite.io/docs/products/mcp returns 200 echo "HTTP status for https://appwrite.io/docs/products/mcp:" curl -s -o /dev/null -w "%{http_code}" https://appwrite.io/docs/products/mcpLength of output: 567
验证通过：MCP 文档链接一致且有效
- English README (line 189) 和中文 README-CN.md (line 182) 均使用
/docs/tooling/mcp链接https://appwrite.io/docs/tooling/mcp返回 HTTP 200，而/docs/products/mcp返回 404，无需修改链接。
✨ Benchmark results
⚡ Benchmark Comparison
|
README.md
Outdated
| @@ -1,5 +1,4 @@ | |||
| > [Get started with Appwrite](https://apwr.dev/appcloud) | |||
| > [Join the Init kick off event 19th of May: The future of Appwrite with Founder & CEO Eldad Fux](https://www.youtube.com/watch?v=1g8tuogsp7A) | |||
| > [Get started with Appwrite](https://apwr.dev/appcloud) > [Join the Init kick off event 19th of May: The future of Appwrite with Founder & CEO Eldad Fux](https://www.youtube.com/watch?v=1g8tuogsp7A) | |||
There was a problem hiding this comment.
weird...something is wrong formatting here.
6 participants
What does this PR do?
Updates README to mention integrated hosting solution, Sites.
Summary by CodeRabbit