DOCS-1156: Update README with subdomain examples (uploadcare-ruby) #182
Conversation
WalkthroughREADME.md updated: all example CDN and file URLs changed from Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks (3 passed)✅ Passed checks (3 passed)
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (1)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
✨ Finishing Touches🧪 Generate unit 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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
README.md (1)
129-140: Update subdomain example TLD to ucarecd.net (not ucarecdn.net).Uploadcare’s current subdomain format uses ucarecd.net (no “n”). Adjust the “With subdomains” example accordingly. (uploadcare.com)
Apply this diff:
# With subdomains enabled: # Uploadcare.config.use_subdomains = true -# => "https://a1b2c3d4e5.ucarecdn.net/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/" +# => "https://a1b2c3d4e5.ucarecd.net/dc99200d-9bd6-4b43-bfa9-aa7bfaefca40/"
🧹 Nitpick comments (1)
README.md (1)
113-113: Clarify legacy vs new CDN domains to prevent confusion.Add a short note that legacy ucarecdn.com remains valid while new projects use per-project subdomains under ucarecd.net, per Uploadcare release notes (July 22, 2025). (uploadcare.com)
Apply this diff:
-In examples we’re going to use `demo.ucarecd.net` domain. Check your project's subdomain in the [Dashboard](https://app.uploadcare.com/projects/-/settings/#delivery). +In examples we’re going to use `demo.ucarecd.net` domain. Legacy `ucarecdn.com` URLs continue to work; new projects use per‑project subdomains under `ucarecd.net`. Check your project's subdomain in the [Dashboard](https://app.uploadcare.com/projects/-/settings/#delivery).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- Jira integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(4 hunks)
🔇 Additional comments (3)
README.md (3)
131-136: LGTM: demo.ucarecd.net examples align with current CDN guidance.The updated example URLs match the new demo/subdomain scheme. (uploadcare.com)
265-265: LGTM: original_file_url host matches demo.ucarecd.net.Consistent with earlier examples and current docs. (uploadcare.com)
1-956: No stale domain references: allucarecdn.netoccurrences are intentional subdomain examples; noucarecdn.comfound.
| # Returns group's CDN URL | ||
| @group.cdn_url | ||
| # => "https://ucarecdn.com/group-id~2/" | ||
| # => "https://demo.ucarecd.net/group-id~2/" | ||
| # With subdomains: "https://a1b2c3d4e5.ucarecdn.net/group-id~2/" | ||
|
|
||
| # Returns CDN URLs of all files from group without API requesting | ||
| @group.file_cdn_urls | ||
| # => 'https://ucarecdn.com/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | ||
| # => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | ||
| # # With subdomains: 'https://a1b2c3d4e5.ucarecdn.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | ||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Fix remaining subdomain examples to use ucarecd.net.
Two “With subdomains” examples still show ucarecdn.net; switch to ucarecd.net. (uploadcare.com)
Apply this diff:
# Returns group's CDN URL
@group.cdn_url
-# => "https://demo.ucarecd.net/group-id~2/"
-# With subdomains: "https://a1b2c3d4e5.ucarecdn.net/group-id~2/"
+# => "https://demo.ucarecd.net/group-id~2/"
+# With subdomains: "https://a1b2c3d4e5.ucarecd.net/group-id~2/"
# Returns CDN URLs of all files from group without API requesting
@group.file_cdn_urls
-# => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/'
-# # With subdomains: 'https://a1b2c3d4e5.ucarecdn.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/'
+# => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/'
+# # With subdomains: 'https://a1b2c3d4e5.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/'📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| # Returns group's CDN URL | |
| @group.cdn_url | |
| # => "https://ucarecdn.com/group-id~2/" | |
| # => "https://demo.ucarecd.net/group-id~2/" | |
| # With subdomains: "https://a1b2c3d4e5.ucarecdn.net/group-id~2/" | |
| # Returns CDN URLs of all files from group without API requesting | |
| @group.file_cdn_urls | |
| # => 'https://ucarecdn.com/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | |
| # => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | |
| # # With subdomains: 'https://a1b2c3d4e5.ucarecdn.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | |
| ``` | |
| # Returns group's CDN URL | |
| @group.cdn_url | |
| # => "https://demo.ucarecd.net/group-id~2/" | |
| # With subdomains: "https://a1b2c3d4e5.ucarecd.net/group-id~2/" | |
| # Returns CDN URLs of all files from group without API requesting | |
| @group.file_cdn_urls | |
| # => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | |
| # # With subdomains: 'https://a1b2c3d4e5.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' |
🤖 Prompt for AI Agents
In README.md around lines 521 to 530, two “With subdomains” example URLs
incorrectly use ucarecdn.net; update both occurrences to use ucarecd.net instead
(i.e., change "https://a1b2c3d4e5.ucarecdn.net/..." to
"https://a1b2c3d4e5.ucarecd.net/...") so the subdomain examples match the
correct ucarecd.net domain.
README.md
Outdated
| @group.file_cdn_urls | ||
| # => 'https://ucarecdn.com/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | ||
| # => 'https://demo.ucarecd.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' | ||
| # # With subdomains: 'https://a1b2c3d4e5.ucarecdn.net/0513dda0-582f-447d-846f-096e5df9e2bb~2/nth/0/' |
There was a problem hiding this comment.
We should remove "with subdomains" part, because now it's with subdomains by default
Summary
Switch generic example URLs in README from ucarecdn.com to demo.ucarecd.net.
Changes
Notes
Docs-only; scope is README. One commit only.
Resolves: DOCS-1156
Summary by CodeRabbit