diff --git a/CONTENT.md b/CONTENT.md index 0886ecd9dfb..91519c1361f 100644 --- a/CONTENT.md +++ b/CONTENT.md @@ -193,7 +193,7 @@ Remember to use a specific language label if the code is using an Appwrite SDK. ### Sections -Use sections when there is a clear step-by-step format to a page. This is used mainly in journey pages and tutorials. +Use sections when there is a clear step-by-step format to a page. This is used mainly in guide pages and tutorials. ```md {% section #featured-products-1 step=1 title="Title" %} diff --git a/STYLE.md b/STYLE.md index 5571caa22ea..f5931914fd6 100644 --- a/STYLE.md +++ b/STYLE.md @@ -94,7 +94,7 @@ Each product page has three main sections - These pages usually align with sections shown in the product in the Appwrite Console. - Focused on describing concepts a user should know, but not actions you might take. - Cover all the details -- Journeys +- Guides - These pages focus on common actions and work flows - Detailed examples that span many concepts - Like cookbook at other organizations' documentation. @@ -222,7 +222,7 @@ Split content such that each piece makes sense without reading dependents or exp - [ ] Update response code [src/routes/docs/apis/response-codes/+page.markdoc](src/routes/docs/apis/response-codes/+page.markdoc) - [ ] Bump latest SDK versions in SDKs page, quick start, and tutorials - [ ] Create new sections for new products -- [ ] Create new concept and journey pages for new features +- [ ] Create new concept and guide pages for new features - [ ] Update docs for breaking changes ### Documenting a new API @@ -351,7 +351,7 @@ easily, and the code example is expected to be runnable and complete. This means, you need to include imports, dependencies, and all parts needed to arrive at a functional example. -For concept and journey product pages, still try your best to have complete examples, unless: +For concept and guide product pages, still try your best to have complete examples, unless: 1. The example will become opinionated. We avoid opinionated implementation and choices in product pages. Keep them in blogs, quick starts, and tutorials. 2. The example cannot be given in a complete form cleanly. For example, many of the Messaging services's examples cannot be given in complete form because the boiler plate and set up is complex and documented in Android/Swift documentation. diff --git a/src/routes/docs/advanced/security/mfa/+page.markdoc b/src/routes/docs/advanced/security/mfa/+page.markdoc index bda35532ff8..d9c4d450fc3 100644 --- a/src/routes/docs/advanced/security/mfa/+page.markdoc +++ b/src/routes/docs/advanced/security/mfa/+page.markdoc @@ -10,7 +10,7 @@ More factors of authentication will be added in the future. {% info title="Looking to add MFA to your app?" %} This page covers MFA for your Appwrite Console account. -If you're looking to add MFA to your app, follow the [Multi-factor authentication journey](/docs/products/auth/mfa). +If you're looking to add MFA to your app, follow the [Multi-factor authentication guide](/docs/products/auth/mfa). {% /info %} # Enable MFA {% #enable-mfa %} diff --git a/src/routes/docs/products/auth/+layout.svelte b/src/routes/docs/products/auth/+layout.svelte index 850ee6aca28..e651ad26125 100644 --- a/src/routes/docs/products/auth/+layout.svelte +++ b/src/routes/docs/products/auth/+layout.svelte @@ -79,7 +79,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Email and password login', diff --git a/src/routes/docs/products/databases/+layout.svelte b/src/routes/docs/products/databases/+layout.svelte index 87f1ffb5a32..6c1f5158d47 100644 --- a/src/routes/docs/products/databases/+layout.svelte +++ b/src/routes/docs/products/databases/+layout.svelte @@ -76,7 +76,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Pagination', diff --git a/src/routes/docs/products/functions/+layout.svelte b/src/routes/docs/products/functions/+layout.svelte index a6ae8dfceeb..738aa5db765 100644 --- a/src/routes/docs/products/functions/+layout.svelte +++ b/src/routes/docs/products/functions/+layout.svelte @@ -51,7 +51,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Templates', diff --git a/src/routes/docs/products/messaging/+layout.svelte b/src/routes/docs/products/messaging/+layout.svelte index 224bbb4a65c..ed4257acc7d 100644 --- a/src/routes/docs/products/messaging/+layout.svelte +++ b/src/routes/docs/products/messaging/+layout.svelte @@ -84,7 +84,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Send push notifications', diff --git a/src/routes/docs/products/messaging/fcm/+page.markdoc b/src/routes/docs/products/messaging/fcm/+page.markdoc index b674fcdbb16..d769eeee1fe 100644 --- a/src/routes/docs/products/messaging/fcm/+page.markdoc +++ b/src/routes/docs/products/messaging/fcm/+page.markdoc @@ -57,7 +57,7 @@ Some additional configuration is required to enable push notifications in your m 1. Add `google-services.json` at the root of your project. 1. Add Google Services class path to your app-level Gradle dependencies block `"com.google.gms:google-services:4.4.0"`. 1. Add Google Services plugin to your app-level Gradle in the plugins block as `"com.google.gms.google-services"`. -1. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](/docs/products/messaging/send-push-notifications#add-targets) journey. +1. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](/docs/products/messaging/send-push-notifications#add-targets) guide. ```xml diff --git a/src/routes/docs/products/messaging/mailgun/+page.markdoc b/src/routes/docs/products/messaging/mailgun/+page.markdoc index 2b63a570aed..597b5e91867 100644 --- a/src/routes/docs/products/messaging/mailgun/+page.markdoc +++ b/src/routes/docs/products/messaging/mailgun/+page.markdoc @@ -319,7 +319,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) journey to send your first push notification and test your provider. +You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/messaging/msg91/+page.markdoc b/src/routes/docs/products/messaging/msg91/+page.markdoc index 0ea24698aec..62e4cd076ab 100644 --- a/src/routes/docs/products/messaging/msg91/+page.markdoc +++ b/src/routes/docs/products/messaging/msg91/+page.markdoc @@ -353,7 +353,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send email messages](/docs/products/messaging/send-sms-messages) journey to send your first push notification and test your provider. +You can follow the [Send email messages](/docs/products/messaging/send-sms-messages) guide to send your first push notification and test your provider. {% /section %} diff --git a/src/routes/docs/products/messaging/sendgrid/+page.markdoc b/src/routes/docs/products/messaging/sendgrid/+page.markdoc index 37ade828b70..0ce661d1afb 100644 --- a/src/routes/docs/products/messaging/sendgrid/+page.markdoc +++ b/src/routes/docs/products/messaging/sendgrid/+page.markdoc @@ -312,7 +312,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send email messages](/docs/products/messaging/send-email-messages) journey to send your first push notification and test your provider. +You can follow the [Send email messages](/docs/products/messaging/send-email-messages) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/messaging/smtp/+page.markdoc b/src/routes/docs/products/messaging/smtp/+page.markdoc index 52e7fd580ab..055fdad50b9 100644 --- a/src/routes/docs/products/messaging/smtp/+page.markdoc +++ b/src/routes/docs/products/messaging/smtp/+page.markdoc @@ -321,7 +321,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) journey to send your first push notification and test your provider. +You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/messaging/targets/+page.markdoc b/src/routes/docs/products/messaging/targets/+page.markdoc index 26c8bf9d1fa..2b6a9344c64 100644 --- a/src/routes/docs/products/messaging/targets/+page.markdoc +++ b/src/routes/docs/products/messaging/targets/+page.markdoc @@ -71,7 +71,7 @@ Push notifications require configuration on both the Appwrite platform and your 1. Add `google-services.json` at the root of your project. 1. Add Google Services class path to your app-level Gradle dependencies block `"com.google.gms:google-services:4.4.0"`. 1. Add Google Services plugin to your app-level Gradle in the plugins block as `"com.google.gms.google-services"`. -1. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](/docs/products/messaging/send-push-notifications#add-targets) journey. +1. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](/docs/products/messaging/send-push-notifications#add-targets) guide. ```xml diff --git a/src/routes/docs/products/messaging/telesign/+page.markdoc b/src/routes/docs/products/messaging/telesign/+page.markdoc index 3b8292fd328..db63679d533 100644 --- a/src/routes/docs/products/messaging/telesign/+page.markdoc +++ b/src/routes/docs/products/messaging/telesign/+page.markdoc @@ -352,7 +352,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) journey to send your first push notification and test your provider. +You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/messaging/textmagic/+page.markdoc b/src/routes/docs/products/messaging/textmagic/+page.markdoc index 76d09c143e0..bd9e5869ddf 100644 --- a/src/routes/docs/products/messaging/textmagic/+page.markdoc +++ b/src/routes/docs/products/messaging/textmagic/+page.markdoc @@ -352,7 +352,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) journey to send your first push notification and test your provider. +You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/messaging/vonage/+page.markdoc b/src/routes/docs/products/messaging/vonage/+page.markdoc index 0d57869a326..e3ff2728dfe 100644 --- a/src/routes/docs/products/messaging/vonage/+page.markdoc +++ b/src/routes/docs/products/messaging/vonage/+page.markdoc @@ -354,7 +354,7 @@ async fn main() -> Result<(), Box> { {% /tabsitem %} {% /tabs %} -You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) journey to send your first push notification and test your provider. +You can follow the [Send SMS messages](/docs/products/messaging/send-sms-messages) guide to send your first push notification and test your provider. {% /section %} {% section #manage-provider step=4 title="Manage provider" %} diff --git a/src/routes/docs/products/sites/+layout.svelte b/src/routes/docs/products/sites/+layout.svelte index 36454587f7d..62c76a92ce8 100644 --- a/src/routes/docs/products/sites/+layout.svelte +++ b/src/routes/docs/products/sites/+layout.svelte @@ -59,7 +59,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Templates', diff --git a/src/routes/docs/products/storage/+layout.svelte b/src/routes/docs/products/storage/+layout.svelte index 358647ae855..122404835c6 100644 --- a/src/routes/docs/products/storage/+layout.svelte +++ b/src/routes/docs/products/storage/+layout.svelte @@ -39,7 +39,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'Upload and download', diff --git a/src/routes/docs/tooling/ai/+layout.svelte b/src/routes/docs/tooling/ai/+layout.svelte index 163e7c56a25..69f0b369f76 100644 --- a/src/routes/docs/tooling/ai/+layout.svelte +++ b/src/routes/docs/tooling/ai/+layout.svelte @@ -105,7 +105,7 @@ ] }, { - label: 'Journeys', + label: 'Guides', items: [ { label: 'AI in Functions', diff --git a/src/routes/docs/tooling/ai/+page.markdoc b/src/routes/docs/tooling/ai/+page.markdoc index 4662f596bb3..97d9884c66b 100644 --- a/src/routes/docs/tooling/ai/+page.markdoc +++ b/src/routes/docs/tooling/ai/+page.markdoc @@ -135,7 +135,7 @@ Open-source benchmark evaluating how well AI models understand Appwrite's APIs a {% /cards_item %} {% /cards %} -# Journeys {% #journeys %} +# Guides {% #guides %} Guides for building AI-powered features on top of Appwrite, from running models in Functions to building full agent pipelines. diff --git a/src/routes/integrations/push-fcm/+page.markdoc b/src/routes/integrations/push-fcm/+page.markdoc index 650ef32154a..c1c6bf3a7a6 100644 --- a/src/routes/integrations/push-fcm/+page.markdoc +++ b/src/routes/integrations/push-fcm/+page.markdoc @@ -59,7 +59,7 @@ To test the provider on mobile apps, there are some additional configuration ste 4. Add `google-services.json` at the root of your project. 5. Add Google Services class path to your app-level Gradle dependencies block `"com.google.gms:google-services:4.4.0"`. 6. Add the Google Services plugin to your app-level Gradle in the plugins block as `"com.google.gms.google-services"`. -7. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](https://appwrite.io/docs/products/messaging/send-push-notifications#add-targets) journey. +7. Add notification handler service to `AndroidManifest.xml` inside the application tag, alongside other activities. Find an example of this service in the [Send push notification](https://appwrite.io/docs/products/messaging/send-push-notifications#add-targets) guide. ```xml