Skip to content

docs: refresh README - #80

Merged
ChiragAgg5k merged 3 commits into
mainfrom
dev
Oct 17, 2026
Merged

ChiragAgg5k merged 3 commits into
mainfrom
dev

Conversation

@ChiragAgg5k

Copy link
Copy Markdown
Member

Refreshes the README with the rewritten getting-started guide and corrected badges, links and install steps from appwrite/sdk-generator#2077 and appwrite/appwrite#14613.

README files only. No code, version or changelog changes, so this does not need a release.

@hansi-codes

hansi-codes Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

🟢 Tier S · Ready to merge

The README refreshes the Ruby SDK’s installation and getting-started guidance with examples for client setup, users, TablesDB, error handling, and self-hosted use, alongside updated badges and documentation links. The latest changes replace HTML entities in the fenced Ruby examples with literal Ruby syntax and placeholders.

Latest changes: The new commits unescape quotes, angle-bracket placeholders, and the rescue operator in the README’s Ruby examples.

Verdict New comments Fixed Still open
✅ Approved 0 1 0
📂 Walkthrough · 1
File Change
README.md Refreshes badges, installation guidance, getting-started examples, self-hosted instructions, and documentation links; the latest commit makes Ruby examples copyable by removing HTML entity escaping.
✅ Fixed since the last review · 1
  • [minor] Use valid Ruby in the fenced examples · README.md:35

Reviewed the commits since 005576d · Details · Comment @hansi-codes review to re-run, or mention @hansi-codes with a question.

@hansi-codes hansi-codes Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 Tier A · Looks good to merge. Summary

Comment thread README.md Outdated

@hansi-codes hansi-codes Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟢 Tier S · Looks good to merge. Summary

@ChiragAgg5k
ChiragAgg5k merged commit e6fa8ea into main Oct 17, 2026
1 check passed
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.

1 participant