Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CONTENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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" %}
Expand Down
6 changes: 3 additions & 3 deletions STYLE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion src/routes/docs/advanced/security/mfa/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/auth/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Email and password login',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/databases/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Pagination',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/functions/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Templates',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Send push notifications',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/fcm/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
<service android:name="<YOUR_NOTIFICATION_HANDLER_SERVICE>" android:exported="false">
<intent-filter>
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/mailgun/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -319,7 +319,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/msg91/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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 %}


Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/sendgrid/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/smtp/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/targets/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
<service android:name="<YOUR_NOTIFICATION_HANDLER_SERVICE>" android:exported="false">
<intent-filter>
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/telesign/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/textmagic/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -352,7 +352,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/messaging/vonage/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
{% /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" %}
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/sites/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Templates',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/products/storage/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'Upload and download',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/tooling/ai/+layout.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
]
},
{
label: 'Journeys',
label: 'Guides',
items: [
{
label: 'AI in Functions',
Expand Down
2 changes: 1 addition & 1 deletion src/routes/docs/tooling/ai/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion src/routes/integrations/push-fcm/+page.markdoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
<service android:name="<YOUR_NOTIFICATION_HANDLER_SERVICE>" android:exported="false">
Expand Down
Loading