Databases -> TablesDB in realtime docs & more#2784
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughThe pull request updates documentation to migrate event namespaces from Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
src/partials/databases-events.md (1)
8-10: Move the migration note into this shared partial for better cross-page clarityThis partial is reused outside the Events page, so readers can see
tablesdb.*without the deprecation context currently shown only insrc/routes/docs/advanced/platform/events/+page.markdoc. Consider adding a short note at the top of this partial itself.💡 Suggested doc tweak
+{% info title="Terminology update" %} +The `databases.*` event prefix has been replaced by `tablesdb.*`. Collections, documents, and attributes are now tables, rows, and columns. +{% /info %} + {% table %}Based on learnings: In Appwrite website documentation (appwrite/website), the standard terminology is now "rows" and "columns" (not "documents" and "collections"), and it should be used consistently across documentation.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@src/partials/databases-events.md` around lines 8 - 10, Add the migration/deprecation note into the shared partial that documents the `tablesdb.*` event so the context appears wherever this partial is reused; update the heading of the partial to include a short migration note, move the existing migration text from the Events page into this partial, and ensure any occurrences use the new standard terminology "rows" and "columns" instead of "documents" and "collections" (search for the `tablesdb.*` text and the previous migration note to copy and remove the original).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@src/routes/docs/advanced/platform/events/`+page.markdoc:
- Around line 25-26: The page claims the `databases.*` event prefix has been
replaced by `tablesdb.*`, but the Realtime examples still use `databases.*`;
update the Realtime examples to use the new `tablesdb.*` event prefix (search
for occurrences of `databases.*` in the Realtime +page.markdoc examples and
replace them with `tablesdb.*`, keeping event payloads and semantics identical),
or alternatively soften the sentence on the advanced/platform/events page to
state that `tablesdb.*` is the preferred/new prefix while legacy `databases.*`
remains supported for compatibility.
---
Nitpick comments:
In `@src/partials/databases-events.md`:
- Around line 8-10: Add the migration/deprecation note into the shared partial
that documents the `tablesdb.*` event so the context appears wherever this
partial is reused; update the heading of the partial to include a short
migration note, move the existing migration text from the Events page into this
partial, and ensure any occurrences use the new standard terminology "rows" and
"columns" instead of "documents" and "collections" (search for the `tablesdb.*`
text and the previous migration note to copy and remove the original).
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 2c5d138a-24b7-4809-8eb8-2062d84a99da
📒 Files selected for processing (2)
src/partials/databases-events.mdsrc/routes/docs/advanced/platform/events/+page.markdoc
Summary by CodeRabbit
databases.*totablesdb.*across platform events docs and examples.