From 631cc15666f6b89c70f43f93c036efcb3eb9500d Mon Sep 17 00:00:00 2001
From: Orta <git@orta.io>
Date: Sat, 11 Jul 2020 13:42:11 -0400
Subject: [PATCH 1/3] Adds a FAQ entry for how to document a svelte component

---
 .../401-how-do-i-document-my-components.md    | 32 +++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 site/content/faq/401-how-do-i-document-my-components.md

diff --git a/site/content/faq/401-how-do-i-document-my-components.md b/site/content/faq/401-how-do-i-document-my-components.md
new file mode 100644
index 000000000000..21ccbfd5e8c9
--- /dev/null
+++ b/site/content/faq/401-how-do-i-document-my-components.md
@@ -0,0 +1,32 @@
+---
+question: How do I document my .svelte files?
+---
+
+In editors which use the Svelte Language Server you can document Components, functions and exports using specially formatted comments.
+
+````svelte
+<script>
+	/** What should we call the user? */
+	export let name = 'world';
+</script>
+
+<!--
+@component
+Here's some documentation for this component. It will show up
+on hover.
+
+- You can use markdown here.
+- You can also use code blocks here.
+- Usage:
+  ```tsx
+  <main name="Arethra">
+  ```
+-->
+<main>
+	<h1>
+		Hello, {name}
+	</h1>
+</main>
+````
+
+Note: The `@component` is necessary in the HTML comment which describes your component.

From b4a446c82e2a020af98949ba0a2fa1514375b25e Mon Sep 17 00:00:00 2001
From: Orta <git@orta.io>
Date: Sun, 12 Jul 2020 16:04:50 -0400
Subject: [PATCH 2/3] Address feedbackl

---
 ...-my-components.md => 450-how-do-i-document-my-components.md} | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
 rename site/content/faq/{401-how-do-i-document-my-components.md => 450-how-do-i-document-my-components.md} (92%)

diff --git a/site/content/faq/401-how-do-i-document-my-components.md b/site/content/faq/450-how-do-i-document-my-components.md
similarity index 92%
rename from site/content/faq/401-how-do-i-document-my-components.md
rename to site/content/faq/450-how-do-i-document-my-components.md
index 21ccbfd5e8c9..73f88dffe289 100644
--- a/site/content/faq/401-how-do-i-document-my-components.md
+++ b/site/content/faq/450-how-do-i-document-my-components.md
@@ -1,5 +1,5 @@
 ---
-question: How do I document my .svelte files?
+question: How do I document my components?
 ---
 
 In editors which use the Svelte Language Server you can document Components, functions and exports using specially formatted comments.

From 1d01e6592551c51a42b2584e781f7046168776bd Mon Sep 17 00:00:00 2001
From: Conduitry <git@chor.date>
Date: Mon, 13 Jul 2020 11:44:46 -0400
Subject: [PATCH 3/3] format

---
 site/content/faq/450-how-do-i-document-my-components.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/site/content/faq/450-how-do-i-document-my-components.md b/site/content/faq/450-how-do-i-document-my-components.md
index 73f88dffe289..78177abd5498 100644
--- a/site/content/faq/450-how-do-i-document-my-components.md
+++ b/site/content/faq/450-how-do-i-document-my-components.md
@@ -12,8 +12,8 @@ In editors which use the Svelte Language Server you can document Components, fun
 
 <!--
 @component
-Here's some documentation for this component. It will show up
-on hover.
+Here's some documentation for this component.
+It will show up on hover.
 
 - You can use markdown here.
 - You can also use code blocks here.