Skip to content

Commit fac8469

Browse files
authored
Merge pull request #3070 from appwrite/journeys-to-guides
Convert journeys to guides in docs
2 parents 40c4905 + cd6ee50 commit fac8469

21 files changed

Lines changed: 23 additions & 23 deletions

File tree

CONTENT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ Remember to use a specific language label if the code is using an Appwrite SDK.
193193

194194
### Sections
195195

196-
Use sections when there is a clear step-by-step format to a page. This is used mainly in journey pages and tutorials.
196+
Use sections when there is a clear step-by-step format to a page. This is used mainly in guide pages and tutorials.
197197

198198
```md
199199
{% section #featured-products-1 step=1 title="Title" %}

STYLE.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ Each product page has three main sections
9494
- These pages usually align with sections shown in the product in the Appwrite Console.
9595
- Focused on describing concepts a user should know, but not actions you might take.
9696
- Cover all the details
97-
- Journeys
97+
- Guides
9898
- These pages focus on common actions and work flows
9999
- Detailed examples that span many concepts
100100
- Like cookbook at other organizations' documentation.
@@ -222,7 +222,7 @@ Split content such that each piece makes sense without reading dependents or exp
222222
- [ ] Update response code [src/routes/docs/apis/response-codes/+page.markdoc](src/routes/docs/apis/response-codes/+page.markdoc)
223223
- [ ] Bump latest SDK versions in SDKs page, quick start, and tutorials
224224
- [ ] Create new sections for new products
225-
- [ ] Create new concept and journey pages for new features
225+
- [ ] Create new concept and guide pages for new features
226226
- [ ] Update docs for breaking changes
227227

228228
### Documenting a new API
@@ -351,7 +351,7 @@ easily, and the code example is expected to be runnable and complete.
351351

352352
This means, you need to include imports, dependencies, and all parts needed to arrive at a functional example.
353353

354-
For concept and journey product pages, still try your best to have complete examples, unless:
354+
For concept and guide product pages, still try your best to have complete examples, unless:
355355

356356
1. The example will become opinionated. We avoid opinionated implementation and choices in product pages. Keep them in blogs, quick starts, and tutorials.
357357
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.

src/routes/docs/advanced/security/mfa/+page.markdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ More factors of authentication will be added in the future.
1010

1111
{% info title="Looking to add MFA to your app?" %}
1212
This page covers MFA for your Appwrite Console account.
13-
If you're looking to add MFA to your app, follow the [Multi-factor authentication journey](/docs/products/auth/mfa).
13+
If you're looking to add MFA to your app, follow the [Multi-factor authentication guide](/docs/products/auth/mfa).
1414
{% /info %}
1515

1616
# Enable MFA {% #enable-mfa %}

src/routes/docs/products/auth/+layout.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@
7979
]
8080
},
8181
{
82-
label: 'Journeys',
82+
label: 'Guides',
8383
items: [
8484
{
8585
label: 'Email and password login',

src/routes/docs/products/databases/+layout.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@
7676
]
7777
},
7878
{
79-
label: 'Journeys',
79+
label: 'Guides',
8080
items: [
8181
{
8282
label: 'Pagination',

src/routes/docs/products/functions/+layout.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@
5151
]
5252
},
5353
{
54-
label: 'Journeys',
54+
label: 'Guides',
5555
items: [
5656
{
5757
label: 'Templates',

src/routes/docs/products/messaging/+layout.svelte

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@
8484
]
8585
},
8686
{
87-
label: 'Journeys',
87+
label: 'Guides',
8888
items: [
8989
{
9090
label: 'Send push notifications',

src/routes/docs/products/messaging/fcm/+page.markdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ Some additional configuration is required to enable push notifications in your m
5757
1. Add `google-services.json` at the root of your project.
5858
1. Add Google Services class path to your app-level Gradle dependencies block `"com.google.gms:google-services:4.4.0"`.
5959
1. Add Google Services plugin to your app-level Gradle in the plugins block as `"com.google.gms.google-services"`.
60-
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.
60+
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.
6161
```xml
6262
<service android:name="<YOUR_NOTIFICATION_HANDLER_SERVICE>" android:exported="false">
6363
<intent-filter>

src/routes/docs/products/messaging/mailgun/+page.markdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -319,7 +319,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
319319
{% /tabsitem %}
320320
{% /tabs %}
321321

322-
You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) journey to send your first push notification and test your provider.
322+
You can follow the [Send email messages](/docs/products/messaging/send-push-notifications) guide to send your first push notification and test your provider.
323323
{% /section %}
324324

325325
{% section #manage-provider step=4 title="Manage provider" %}

src/routes/docs/products/messaging/msg91/+page.markdoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
353353
{% /tabsitem %}
354354
{% /tabs %}
355355

356-
You can follow the [Send email messages](/docs/products/messaging/send-sms-messages) journey to send your first push notification and test your provider.
356+
You can follow the [Send email messages](/docs/products/messaging/send-sms-messages) guide to send your first push notification and test your provider.
357357
{% /section %}
358358

359359

0 commit comments

Comments
 (0)