Merge pull request #96 from appwrite/eldad-comment-fixes

Eldad comment fixes
appwrite · Sep 28, 2023 · 9768ff0 · 9768ff0
2 parents 5f75d21 + 3ad7f7c
commit 9768ff0
Show file tree

Hide file tree

Showing 44 changed files with 74 additions and 40 deletions.
diff --git a/src/icons/svg/vue.svg b/src/icons/svg/vue.svg
diff --git a/src/lib/layouts/DocsArticle.svelte b/src/lib/layouts/DocsArticle.svelte
@@ -14,15 +14,15 @@
 
 <script lang="ts">
 	export let title: string;
-	export let back: string;
 	export let toc: Array<TocItem>;
+	export let back: string | undefined = undefined;
 </script>
 
 <main class="u-contents">
 	<article class="aw-article u-contents">
 		<header class="aw-article-header">
 			<div class="aw-article-header-start u-flex-vertical aw-u-cross-start">
-				{#if back !== undefined}
+				{#if back}
 					<a
 						href={back}
 						class="
@@ -37,7 +37,7 @@
 					<slot name="metadata" />
 				</ul>
 				<div class="u-position-relative u-flex u-cross-center">
-					{#if back !== undefined}
+					{#if back}
 						<a
 							href={back}
 							class="

diff --git a/src/markdoc/layouts/Article.svelte b/src/markdoc/layouts/Article.svelte
@@ -23,9 +23,9 @@
 
 	export let title: string;
 	export let description: string;
-	export let back: string = '';
-	export let difficulty: string = '';
-	export let readtime: string = '';
+	export let back: string | undefined = undefined;
+	export let difficulty: string | undefined = undefined;
+	export let readtime: string | undefined = undefined;
 
 	setContext<LayoutContext>('headings', writable({}));
 

diff --git a/src/markdoc/nodes/Image.svelte b/src/markdoc/nodes/Image.svelte
@@ -12,6 +12,6 @@
 	<img {src} {alt} {title} loading="lazy" style:vertical-align="middle" />
 {:else}
 	<div class="aw-media">
-		<img {src} {alt} {title} loading="lazy" />
+		<img {src} {alt} {title} loading="lazy" class="aw-u-media-ratio-16-9" />
 	</div>
 {/if}
diff --git a/src/routes/docs/+page.svelte b/src/routes/docs/+page.svelte
@@ -294,7 +294,6 @@
 						<a
 							class="aw-grid-articles-item is-full-color"
 							href="/docs/tutorials/react"
-							target="_blank"
 							rel="noopener noreferrer"
 						>
 							<div class="aw-grid-articles-item-image">
@@ -321,7 +320,6 @@
 						<a
 							class="aw-grid-articles-item is-full-color"
 							href="/docs/tutorials/sveltekit"
-							target="_blank"
 							rel="noopener noreferrer"
 						>
 							<div class="aw-grid-articles-item-image">
@@ -348,7 +346,6 @@
 						<a
 							class="aw-grid-articles-item is-full-color"
 							href="/docs/tutorials/vue"
-							target="_blank"
 							rel="noopener noreferrer"
 						>
 							<div class="aw-grid-articles-item-image">
@@ -375,7 +372,6 @@
 						<a
 							class="aw-grid-articles-item is-full-color"
 							href="/docs/tutorials/android"
-							target="_blank"
 							rel="noopener noreferrer"
 						>
 							<div class="aw-grid-articles-item-image">
@@ -402,7 +398,6 @@
 						<a
 							class="aw-grid-articles-item is-full-color"
 							href="/docs/tutorials/flutter"
-							target="_blank"
 							rel="noopener noreferrer"
 						>
 							<div class="aw-grid-articles-item-image">

diff --git a/src/routes/docs/products/auth/quick-start/+page.markdoc b/src/routes/docs/products/auth/quick-start/+page.markdoc
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: Quick start
+title: Start with Authentication
 description: Effortlessly add authentication to your apps - simple signup & login in just minutes with Appwrite Authentication
 ---
 You can get up and running with Appwrite Authentication in minutes. 

diff --git a/src/routes/docs/products/databases/quick-start/+page.markdoc b/src/routes/docs/products/databases/quick-start/+page.markdoc
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: Quick start
+title: Start with Databases
 description: Get started with Appwrite Databases. Follow a step-by-step guide to create your first database, define collections, and perform basic data operations.
 ---
 

diff --git a/src/routes/docs/products/functions/quick-start/+page.markdoc b/src/routes/docs/products/functions/quick-start/+page.markdoc
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: Quick start
+title: Start with Functions
 description: Get started quickly with Appwrite Functions. Follow a step-by-step guide to create your first serverless function, define triggers, and execute code.
 ---
 You can create and execute your first Appwrite Function in minutes.

diff --git a/src/routes/docs/products/storage/+layout.svelte b/src/routes/docs/products/storage/+layout.svelte
@@ -42,7 +42,7 @@
 					href: '/docs/products/storage/upload-download'
 				},
 				{
-					label: 'Images',
+					label: 'Image transformations',
 					href: '/docs/products/storage/images'
 				},
 			]

diff --git a/src/routes/docs/products/storage/images/+page.markdoc b/src/routes/docs/products/storage/images/+page.markdoc
@@ -1,15 +1,13 @@
 ---
 layout: article
-title: Images
+title: Image transformations
 description: Optimize image storage and processing with Appwrite. Explore image resizing, transformations, and manipulation to deliver rich media experiences in your apps.
 difficulty: beginner
 readtime: 15
 ---
 
 Appwrite provides utilities to manipulate images for previewing images in your apps.
 
-# Image manipulation {% #image-manupulation %}
-
 Appwrite Storage's [preview endpoint](/docs/references/cloud/client-web/storage#getFilePreview) let you manipulate resolution, add borders and the border-radius, add background-color, set the opacity for the image, and get the image in the appropriate output format.
 
 You can manipulate images resolution to display appropriately on responsive websites. You can also adjust the image border, background color, and border-radius to match the theming of your application. 
@@ -20,6 +18,8 @@ When manipulating images in Appwrite, the resulting images are cached by Appwrit
 When you repeatedly use the same transformed images, the performance impact will be minimal.
 {% /info %}
 
+## Options {% #options %}
+
 Below you can find all the different parameters offered by the preview endpoint to manipulate the image.
 
 | Parameter     | Description                                                                                                     |

diff --git a/src/routes/docs/products/storage/quick-start/+page.markdoc b/src/routes/docs/products/storage/quick-start/+page.markdoc
@@ -1,6 +1,6 @@
 ---
 layout: article
-title: Quick start
+title: Start with Storage
 description: Get started quickly with Appwrite Storage. Follow step-by-step instructions to set up storage, upload files, and integrate cloud storage into your projects
 difficulty: beginner
 readtime: 5

diff --git a/src/routes/docs/quick-starts/+page.svelte b/src/routes/docs/quick-starts/+page.svelte
@@ -33,7 +33,7 @@
 				},
 				{
 					title: 'Vue.js',
-					icon: 'icon-vue',
+					icon: 'aw-icon-vue',
 					image: '/images/blog/placeholder.png',
 					href: 'vue'
 				},
@@ -73,7 +73,7 @@
 			quickStarts: [
 				{
 					title: 'Node.js',
-					icon: 'icon-node',
+					icon: 'icon-node_js',
 					image: '/images/blog/placeholder.png',
 					href: 'node'
 				},

diff --git a/src/routes/docs/quick-starts/android/+page.markdoc b/src/routes/docs/quick-starts/android/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Android
 description: Get started with Appwrite on Android and learn how to build secure and scalable apps using our powerful backend.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 Learn to setup your first Android project powered by Appwrite and the [Appwrite Android SDK](https://github.com/appwrite/sdk-for-android).

diff --git a/src/routes/docs/quick-starts/angular/+page.markdoc b/src/routes/docs/quick-starts/angular/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Angular
 description: Learn how to use Appwrite to add authentication, user management, file storage, and more to your Angular apps.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 

diff --git a/src/routes/docs/quick-starts/apple/+page.markdoc b/src/routes/docs/quick-starts/apple/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Apple
 description: Build iOS apps with Appwrite and learn how to use our powerful backend to add authentication, user management, file storage, and more.
 difficulty: beginner
 readtime: 10
+back: /docs/quick-starts
 ---
 
 Learn to setup your first Apple project powered by Appwrite and the [Appwrite Apple SDK](https://github.com/appwrite/sdk-for-apple).

diff --git a/src/routes/docs/quick-starts/dotnet/+page.markdoc b/src/routes/docs/quick-starts/dotnet/+page.markdoc
@@ -2,6 +2,9 @@
 layout: article
 title: Start with .NET
 description: Learn to get started with server integrations with Appwrite .NET SDK.
+difficulty: beginner
+readtime: 5
+back: /docs/quick-starts
 ---
 Learn to setup your first .NET project powered by Appwrite.
 {% section #step-1 step=1 title="Create project" %}

diff --git a/src/routes/docs/quick-starts/flutter/+page.markdoc b/src/routes/docs/quick-starts/flutter/+page.markdoc
@@ -3,7 +3,8 @@ layout: article
 title: Start with Flutter
 description: Build Flutter apps with Appwrite and learn how to use our powerful backend to add authentication, user management, file storage, and more.
 difficulty: beginner
-readtime: 3
+readtime: 10
+back: /docs/quick-starts
 ---
 
 Learn to setup your first Flutter project powered by Appwrite.

diff --git a/src/routes/docs/quick-starts/nextjs/+page.markdoc b/src/routes/docs/quick-starts/nextjs/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Next.js
 description: Learn how to use Appwrite to add authentication, user management, file storage, and more to your Next.js apps.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 Learn to setup your first Next.js project powered by Appwrite.
 {% section #step-1 step=1 title="Create project" %}

diff --git a/src/routes/docs/quick-starts/node/+page.markdoc b/src/routes/docs/quick-starts/node/+page.markdoc
@@ -2,6 +2,9 @@
 layout: article
 title: Start with Node.js
 description: Dive into our step-by-step guide on integrating Appwrite with your Node.js server backend application. Get your backend up and running quickly with this tutorial.
+difficulty: beginner
+readtime: 5
+back: /docs/quick-starts
 ---
 Learn to setup your first Node.js project powered by Appwrite.
 {% section #step-1 step=1 title="Create project" %}

diff --git a/src/routes/docs/quick-starts/nuxt/+page.markdoc b/src/routes/docs/quick-starts/nuxt/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Nuxt
 description: Build Nuxt.js apps with Appwrite and learn how to use our powerful backend to add authentication, user management, file storage, and more.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 Learn to setup your first Nuxt project powered by Appwrite.

diff --git a/src/routes/docs/quick-starts/python/+page.markdoc b/src/routes/docs/quick-starts/python/+page.markdoc
@@ -2,6 +2,9 @@
 layout: article
 title: Start with Python
 description: Learn to get started with server integrations with Appwrite Python SDK.
+difficulty: beginner
+readtime: 5
+back: /docs/quick-starts
 ---
 Learn to setup your first Python project powered by Appwrite.
 {% section #step-1 step=1 title="Create project" %}

diff --git a/src/routes/docs/quick-starts/qwik/+page.markdoc b/src/routes/docs/quick-starts/qwik/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Qwik
 description: Learn how to use Appwrite to add authentication, user management, file storage, and more to your Qwik apps.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 Improve the docs, add this guide.

diff --git a/src/routes/docs/quick-starts/react/+page.markdoc b/src/routes/docs/quick-starts/react/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with React
 description: Build React apps with Appwrite and learn how to use our powerful backend to add authentication, user management, file storage, and more.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 Learn to setup your first React project powered by Appwrite.

diff --git a/src/routes/docs/quick-starts/sveltekit/+page.markdoc b/src/routes/docs/quick-starts/sveltekit/+page.markdoc
@@ -2,6 +2,9 @@
 layout: article
 title: Start with SvelteKit
 description: Learn how to use Appwrite to add authentication, user management, file storage, and more to your SvelteKit apps.
+difficulty: beginner
+readtime: 3
+back: /docs/quick-starts
 ---
 Learn to setup your first SvelteKit project powered by Appwrite.
 {% section #step-1 step=1 title="Create project" %}

diff --git a/src/routes/docs/quick-starts/vue/+page.markdoc b/src/routes/docs/quick-starts/vue/+page.markdoc
@@ -4,6 +4,7 @@ title: Start with Vue.js
 description: Build Vue.js apps with Appwrite and learn how to use our powerful backend to add authentication, user management, file storage, and more.
 difficulty: beginner
 readtime: 3
+back: /docs/quick-starts
 ---
 
 Learn to setup your first Vue project powered by Appwrite.

diff --git a/src/routes/docs/tutorials/+page.svelte b/src/routes/docs/tutorials/+page.svelte
@@ -53,7 +53,7 @@
 					<li class="is-mobile-col-span-2">
 						<a href="/docs/tutorials/vue" class="aw-card is-normal">
 							<header class="u-flex u-cross-baseline u-gap-4">
-								<span class="icon-vue aw-u-font-size-24" aria-hidden="true" />
+								<span class="aw-icon-vue aw-u-font-size-24" aria-hidden="true" />
 								<h4 class="aw-sub-body-500 aw-u-color-text-primary">Vue</h4>
 							</header>
 							<p class="aw-sub-body-400 u-margin-block-start-4">

diff --git a/src/routes/docs/tutorials/vue/step-1/+page.markdoc b/src/routes/docs/tutorials/vue/step-1/+page.markdoc
@@ -3,6 +3,7 @@ layout: tutorial
 title: Build an ideas tracker with Vue.js
 description: Learn to build an idea tracker app with Appwrite and Vue with authentication, databases and collections, queries, pagination, and file storage.
 step: 1
+back: /docs
 ---
 
 **Idea tracker**: an app to track all the side project ideas that you'll start, but probably never finish.

diff --git a/static/icon-font/_variables.scss b/static/icon-font/_variables.scss
@@ -33,5 +33,6 @@ $aw-icon-rest: "\ea20";
 $aw-icon-search: "\ea21";
 $aw-icon-star: "\ea22";
 $aw-icon-twitter: "\ea23";
-$aw-icon-x: "\ea24";
-$aw-icon-youtube: "\ea25";
+$aw-icon-vue: "\ea24";
+$aw-icon-x: "\ea25";
+$aw-icon-youtube: "\ea26";
diff --git a/static/icon-font/aw-icon.css b/static/icon-font/aw-icon.css
@@ -52,5 +52,6 @@
 .aw-icon-search:before { content: "\ea21"; }
 .aw-icon-star:before { content: "\ea22"; }
 .aw-icon-twitter:before { content: "\ea23"; }
-.aw-icon-x:before { content: "\ea24"; }
-.aw-icon-youtube:before { content: "\ea25"; }
+.aw-icon-vue:before { content: "\ea24"; }
+.aw-icon-x:before { content: "\ea25"; }
+.aw-icon-youtube:before { content: "\ea26"; }
diff --git a/static/icon-font/aw-icon.eot b/static/icon-font/aw-icon.eot
diff --git a/static/icon-font/aw-icon.scss b/static/icon-font/aw-icon.scss
@@ -51,8 +51,9 @@
 .aw-icon-search:before { content: "\ea21"; }
 .aw-icon-star:before { content: "\ea22"; }
 .aw-icon-twitter:before { content: "\ea23"; }
-.aw-icon-x:before { content: "\ea24"; }
-.aw-icon-youtube:before { content: "\ea25"; }
+.aw-icon-vue:before { content: "\ea24"; }
+.aw-icon-x:before { content: "\ea25"; }
+.aw-icon-youtube:before { content: "\ea26"; }
 
 $aw-icon-apple: "\ea01";
 $aw-icon-arrow-down: "\ea02";
@@ -89,5 +90,6 @@ $aw-icon-rest: "\ea20";
 $aw-icon-search: "\ea21";
 $aw-icon-star: "\ea22";
 $aw-icon-twitter: "\ea23";
-$aw-icon-x: "\ea24";
-$aw-icon-youtube: "\ea25";
+$aw-icon-vue: "\ea24";
+$aw-icon-x: "\ea25";
+$aw-icon-youtube: "\ea26";
diff --git a/static/icon-font/aw-icon.svg b/static/icon-font/aw-icon.svg
diff --git a/static/icon-font/aw-icon.symbol.svg b/static/icon-font/aw-icon.symbol.svg
diff --git a/static/icon-font/aw-icon.ttf b/static/icon-font/aw-icon.ttf
diff --git a/static/icon-font/aw-icon.woff b/static/icon-font/aw-icon.woff
diff --git a/static/icon-font/aw-icon.woff2 b/static/icon-font/aw-icon.woff2
diff --git a/static/icon-font/info.json b/static/icon-font/info.json
@@ -209,16 +209,22 @@
     "className": "aw-icon-twitter",
     "unicode": "&#59939;"
   },
-  "x": {
+  "vue": {
     "encodedCode": "\\ea24",
     "prefix": "aw-icon",
-    "className": "aw-icon-x",
+    "className": "aw-icon-vue",
     "unicode": "&#59940;"
   },
-  "youtube": {
+  "x": {
     "encodedCode": "\\ea25",
     "prefix": "aw-icon",
-    "className": "aw-icon-youtube",
+    "className": "aw-icon-x",
     "unicode": "&#59941;"
+  },
+  "youtube": {
+    "encodedCode": "\\ea26",
+    "prefix": "aw-icon",
+    "className": "aw-icon-youtube",
+    "unicode": "&#59942;"
   }
 }
diff --git a/static/images/docs/functions/quick-start/create-function.png b/static/images/docs/functions/quick-start/create-function.png
diff --git a/static/images/docs/functions/quick-start/dark/create-function.png b/static/images/docs/functions/quick-start/dark/create-function.png
diff --git a/static/images/docs/functions/template.png b/static/images/docs/functions/template.png
diff --git a/static/images/docs/quick-starts/create-project.png b/static/images/docs/quick-starts/create-project.png
diff --git a/static/images/docs/quick-starts/dark/create-project.png b/static/images/docs/quick-starts/dark/create-project.png
diff --git a/static/images/docs/tutorials/idea-tracker.png b/static/images/docs/tutorials/idea-tracker.png