Bifurcate Advanced > Platform docs into other relevant sections#3038
Bifurcate Advanced > Platform docs into other relevant sections#3038adityaoberai wants to merge 10 commits into
Conversation
Appwrite WebsiteProject ID: Website (appwrite/website)Project ID: Tip Silent mode disables those chatty PR comments if you prefer peace and quiet |
| @@ -0,0 +1,61 @@ | |||
| <script lang="ts"> | |||
There was a problem hiding this comment.
I feel like this page could be a container for simply just APIs and we can drop the integration part. Maybe have some overview of the different APIs types Appwrite support and why we offer different types. We can still link to the different API types directly from the main navigation like we do now.
There was a problem hiding this comment.
We can even use the existing /docs/apis path.
There was a problem hiding this comment.
I had thought about that but right now the APIs section is structured to contain info on the different protocols.
This broadens the scope of the section. If that is alright, I can directly shift these there.
There was a problem hiding this comment.
I think we can, it really make sense the more I look at the content. We can have a sub category for protocols and around them all the common things like response models or events, links structure will also work really well this way.
There was a problem hiding this comment.
I've gotten a version of this ready, need a review
- Remove deprecated Scale plan from Billing (page, nav, card); redirect old platform path to Pro - Regroup Billing: move the payments page out of Plans into 'Manage billing' - Fold former API Integration content into the APIs section; drop the standalone section - Add an 'Events & Errors' subsection (events, webhooks, response codes, error handling) via URL-invisible route groups; leave REST/GraphQL/Realtime untouched - Move Release policy to Advanced - Repoint redirects and internal links; update STYLE.md - Add Sept 1, 2026 deprecation date to Dev keys note; fix malformed release-policy anchor Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
@greptile-app review? |
Greptile SummaryThis PR splits the monolithic Advanced → Platform docs section into focused homes: a new
Confidence Score: 5/5This is a documentation-only restructuring; no application logic is changed, and every former URL has a redirect entry pointing to a verified existing page. All 26 new redirects were verified against the corresponding page files that are created or moved in this PR. A grep of the entire /docs tree confirms zero residual advanced/platform links in documentation content. The Sidebar and each sub-section layout are internally consistent. The env var table additions are additive and do not alter existing rows. Two pre-existing bugs in the Security overview (wrong TLS href, missing MFA card) are also corrected here. No files require special attention. The redirect table in src/redirects.json is the highest-risk file in any URL restructuring but has been reviewed and all targets exist. Important Files Changed
Reviews (1): Last reviewed commit: "Format env var tables" | Re-trigger Greptile |

What does this PR do?
Breaks up the catch-all Advanced → Platform docs section, which had grown into an unrelated mix of billing, API integration, security, and product-specific pages. Its contents are redistributed into three focused homes plus the relevant product sections, so each page now lives where users actually look for it. Every moved URL is covered by a redirect, and all internal doc links, navigation, and overview pages are updated to match.
New sections
/docs/advanced/billing— new landing page + layout, covering plans, add-ons, SLAs, and billing policies./docs/advanced/api-integration— new landing page + layout (also absorbs the old/docs/advanced/integrationstub), covering events, webhooks, and the API error reference.Pages moved
…/advanced/platform/…events,webhooks,response-codes,error-handling,release-policy…/advanced/api-integration/…billing→payments,free,pro,scale,enterprise,oss,compute,phone-otp,image-transformations,database-reads-and-writes,support-sla,uptime-sla,fair-use-policy,abuse,refund-policy…/advanced/billing/…roles,permissions,rate-limits,api-keys,dev-keys,environment-variables…/advanced/security/…message-templates…/products/auth/…custom-domains…/products/network/custom-domainsshortcuts…/tooling/command-center/shortcutsSupporting updates
/docs/advanced/platform/*path (and/docs/advanced/platform→/docs,/docs/advanced/integration→/docs/advanced/api-integration) to its new home; repointed existing redirects (/docs/keys,/docs/permissions,/docs/events,/docs/webhooks, etc.)./docs/**content links, partials, components, the init page,llms.txtgenerators, andSTYLE.mdto the new paths.Test Plan
Visit all relevant sections in
/docsRelated PRs and Issues
N/A
Have you read the Contributing Guidelines on issues?
Yes