Skip to content

Databases Documentation#3072

Open
atharvadeosthale wants to merge 5 commits into
stardustfrom
stardust-databases
Open

Databases Documentation#3072
atharvadeosthale wants to merge 5 commits into
stardustfrom
stardust-databases

Conversation

@atharvadeosthale

Copy link
Copy Markdown
Member

Summary

  • Moved TablesDB to live within the databases section and set up redirects from the previous URLs.
  • Added DocumentsDB documentation content, with the other database types in place as placeholders for now.

Split the Databases docs into a menu of database types. The /docs/products/databases
overview becomes a menu (Appwrite databases: TablesDB, DocumentsDB, VectorsDB;
Native databases: PostgreSQL, MySQL). Existing TablesDB content moves under
/tablesdb with its full sidebar; DocumentsDB, VectorsDB, PostgreSQL, and MySQL get
their own sections with placeholder overviews. Adds redirects for all moved pages.
Add DocumentsDB docs (concepts and journeys) under databases/documentsdb, move TablesDB within the databases section with redirects from the previous URLs, and align the backups and bulk operations pages.
@appwrite

appwrite Bot commented Jun 29, 2026

Copy link
Copy Markdown

Appwrite Website

Project ID: 69d7efb00023389e8d27

Sites (1)
Site Status Logs Preview QR
 website
69d7f2670014e24571ca
Building Building View Logs Preview URL QR Code

Website (appwrite/website)

Project ID: 684969cb000a2f6c0a02

Sites (1)
Site Status Logs Preview QR
 website
68496a17000f03d62013
Queued Queued View Logs Preview URL QR Code


Tip

Environment variable changes require redeployment to take effect

@atharvadeosthale atharvadeosthale changed the base branch from main to stardust June 29, 2026 14:43
@greptile-apps

greptile-apps Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR restructures the Appwrite Databases documentation by moving TablesDB under a new /docs/products/databases/tablesdb/ path, adding a shared Databases overview page, scaffolding DocumentsDB docs with real content, and providing placeholder layouts for VectorsDB, MySQL, and PostgreSQL. All previous flat URLs (/docs/products/databases/*) are covered by new redirect entries.

  • Redirects: ~40 entries added to redirects.json mapping old flat paths to tablesdb/; existing short-link redirects (/docs/databases-queries, /docs/queries, etc.) updated to match.
  • Legacy API banner: tablesdb/legacy/+layout.svelte adds a reactive deprecation notice with a URL transformer that correctly remaps documents→rows and collections→tables.
  • DocumentsDB content: Full documentation added for collections, documents, queries, backups, bulk ops, and import/export, with matching images and cache entries.

Confidence Score: 5/5

Safe to merge — all changed files are documentation content and routing config with no application logic changes.

The changes are documentation pages, sidebar layouts, and redirect rules. The redirect coverage for old URLs is thorough, the deprecation banner logic is straightforward, and all new image files have matching cache entries. The two findings are cosmetic/navigational nits that do not break any routes.

No files require special attention beyond the two minor inconsistencies flagged in tablesdb/legacy/+page.ts and vectorsdb/+layout.svelte.

Important Files Changed

Filename Overview
src/redirects.json Adds ~40 redirects for all old /docs/products/databases/* paths to /docs/products/databases/tablesdb/*, and updates three existing redirects that pointed to the former flat databases structure; coverage looks complete.
src/routes/docs/products/databases/tablesdb/legacy/+page.ts Redirects /docs/products/databases/tablesdb/legacy to an intermediate URL that is itself redirected again by redirects.json; should point directly to /docs/products/databases/tablesdb/databases.
src/routes/docs/products/databases/vectorsdb/+layout.svelte New VectorsDB sidebar layout; uses label: 'VectorsDB' for the parent back-link, inconsistent with tablesdb/mysql/postgresql which all use label: 'Databases'.
src/routes/docs/products/databases/tablesdb/legacy/+layout.svelte Adds a deprecation info banner with a reactive URL transformer that correctly strips legacy/ and maps documents to rows and collections to tables.
src/routes/docs/products/databases/documentsdb/+layout.svelte New DocumentsDB sidebar layout; parent label is 'DocumentsDB' instead of 'Databases' (already flagged in a previous review thread).
src/routes/docs/products/databases/(overview)/+page.markdoc New Databases overview page presenting TablesDB, DocumentsDB, VectorsDB, PostgreSQL, and MySQL product cards; content looks accurate.
.optimize-cache.json Adds cache entries for all new DocumentsDB images; each committed .avif file has a corresponding .png cache entry (extension difference is intentional per project convention).

Reviews (2): Last reviewed commit: "Address review feedback on DocumentsDB d..." | Re-trigger Greptile

Comment on lines +7 to +10
const parent: NavParent = {
href: '/docs/products/databases',
label: 'DocumentsDB'
};

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P1 The parent.label for DocumentsDB is set to 'DocumentsDB' but the parent.href points to /docs/products/databases (the Databases overview). The Sidebar renders this label as a visible section heading above a back-arrow link. Every other database sub-product layout — tablesdb, mysql, postgresql, vectorsdb — correctly uses label: 'Databases' for this same parent href, so DocumentsDB users would see a confusing "DOCUMENTSDB" label where they'd expect "DATABASES".

Suggested change
const parent: NavParent = {
href: '/docs/products/databases',
label: 'DocumentsDB'
};
const parent: NavParent = {
href: '/docs/products/databases',
label: 'Databases'
};

Comment on lines +17 to 19
{% arrow_link href="/docs/products/databases/tablesdb/quick-start" %}
Quick start
{% /arrow_link %} No newline at end of file

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 The file is missing a trailing newline. Many editors and linters expect text files to end with a newline character.

Suggested change
{% arrow_link href="/docs/products/databases/tablesdb/quick-start" %}
Quick start
{% /arrow_link %}
{% arrow_link href="/docs/products/databases/tablesdb/quick-start" %}
Quick start
{% /arrow_link %}

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Comment thread src/routes/docs/products/databases/documentsdb/backups/+page.markdoc Outdated
Comment thread src/routes/docs/products/databases/documentsdb/bulk-operations/+page.markdoc Outdated
@atharvadeosthale

Copy link
Copy Markdown
Member Author

WIP - console screenshots & import / export

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.

2 participants