Bifurcate Advanced > Platform docs into other relevant sections#3038
Bifurcate Advanced > Platform docs into other relevant sections#3038adityaoberai wants to merge 3 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 |
adityaoberai
requested review from
atharvadeosthale and
eldadfux
and removed request for
eldadfux
| --- | ||
|
|
||
| {% info title="Deprecation notice" %} | ||
| Dev keys are going to be deprecated soon. We recommend planning your migration away from dev keys ahead of time. |
There was a problem hiding this comment.
We can do that once we have the Init dates finalised.
There was a problem hiding this comment.
I think we can do it regardless of Init, even if removed from console, they will still work on the API side
There was a problem hiding this comment.
I'll confirm with Matej on this, update it
| @@ -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.
| href: '/docs/advanced/billing/pro' | ||
| }, | ||
| { | ||
| label: 'Scale', |
There was a problem hiding this comment.
Oh yes, I'll fix this
| Learn which plan best suits your organization and how to manage billing. | ||
|
|
||
| {% cards %} | ||
| {% cards_item href="/docs/advanced/billing/payments" title="Billing" %} |
There was a problem hiding this comment.
Having a billing page inside the billing section doesn't work well it is also nested under the title Plans we can break it or/and have some of its information on the overview
There was a problem hiding this comment.
My mistake, I forgot this change. Will fix
| href: '/docs/advanced/security/rate-limits' | ||
| }, | ||
| { | ||
| label: 'API keys', |
There was a problem hiding this comment.
We will soon need to refactor this to explain project keys vs account keys vs org keys.
There was a problem hiding this comment.
That will happen as soon as the Projects API section is ready for release. I will coordinate with Atharva on this.
2 participants
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