-
Notifications
You must be signed in to change notification settings - Fork 4.6k
Update README.md #10153
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Update README.md #10153
Conversation
WalkthroughThe README.md file was updated to replace the previous announcement about "Encrypted string attribute support for Appwrite Databases" with a new announcement highlighting "Auto-increment support for Appwrite Databases," including an updated link to the relevant blog post. Changes
Possibly related PRs
Suggested reviewers
Poem
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! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
README.md (1)
8-9
: Invalid HTML – nested un-escaped double quotes break thealt
attributeThe
alt
attribute is wrapped in double quotes and also contains double quotes inside, which makes the markup invalid and may break some renderers or tooling.- <a href="https://appwrite.io" target="_blank"><img src="./public/images/banner.png" alt="Appwrite banner, with logo and text saying "Build Like a Team of Hundreds""></a> + <a href="https://appwrite.io" target="_blank"><img src="./public/images/banner.png" alt="Appwrite banner, with logo and text saying "Build Like a Team of Hundreds""></a>Escaping (or switching to single quotes) prevents the attribute from being prematurely terminated.
🧹 Nitpick comments (1)
README.md (1)
2-3
: Double-check blog-post URL and add trailing slash for consistencyThe announcement looks good, but please make sure the URL actually resolves (the blog sometimes enforces a trailing slash).
If it does, ignore; if not, consider:-> We just announced Auto-increment support for Appwrite Databases - [Learn more](https://appwrite.io/blog/post/announcing-auto-increment-support) +> We just announced Auto-increment support for Appwrite Databases — [Learn more](https://appwrite.io/blog/post/announcing-auto-increment-support/)Running a quick
curl -I
(head request) against both variants will confirm which one returns200 OK
.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ItzNotABug
PR: appwrite/appwrite#9693
File: src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Indexes/Delete.php:40-40
Timestamp: 2025-06-25T06:25:45.054Z
Learning: In Appwrite's database module, the event label for deleting a table index intentionally uses 'update' (e.g., 'databases.[databaseId].tables.[tableId].indexes.[indexId].update') instead of 'delete', to match legacy behavior as seen in previous controller implementations.
Learnt from: ItzNotABug
PR: appwrite/appwrite#9673
File: app/controllers/api/migrations.php:360-386
Timestamp: 2025-04-21T06:43:39.808Z
Learning: In the Appwrite codebase, only files under 20MB are either compressed or encrypted or both, which means loading these files entirely into memory is acceptable from a resource usage perspective.
README.md (2)
Learnt from: ItzNotABug
PR: appwrite/appwrite#9693
File: src/Appwrite/Platform/Modules/Databases/Http/Databases/Tables/Indexes/Delete.php:40-40
Timestamp: 2025-06-25T06:25:45.054Z
Learning: In Appwrite's database module, the event label for deleting a table index intentionally uses 'update' (e.g., 'databases.[databaseId].tables.[tableId].indexes.[indexId].update') instead of 'delete', to match legacy behavior as seen in previous controller implementations.
Learnt from: ItzNotABug
PR: appwrite/appwrite#9673
File: app/controllers/api/migrations.php:360-386
Timestamp: 2025-04-21T06:43:39.808Z
Learning: In the Appwrite codebase, only files under 20MB are either compressed or encrypted or both, which means loading these files entirely into memory is acceptable from a resource usage perspective.
What does this PR do?
(Provide a description of what this PR does and why it's needed.)
Test Plan
(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.)
Related PRs and Issues
Checklist
Summary by CodeRabbit