chore: Warn people away from examples folder

TypeStrong · Jul 4, 2021 · 3c5ae51 · 3c5ae51
1 parent 3f30c35
commit 3c5ae51
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/examples/basic/README.md b/examples/basic/README.md
@@ -1,6 +1,6 @@
 # Example
 
-> Example Documentation
+> **This is not actually an example.** It is used by TypeDoc's tests. For example documentation https://typedoc.org/api/ is recommended.
 
 ## Installation
 

diff --git a/src/test/renderer/specs/index.html b/src/test/renderer/specs/index.html
@@ -62,7 +62,7 @@ <h1>typedoc</h1>
 					<h1>Example</h1>
 				</a>
 				<blockquote>
-					<p>Example Documentation</p>
+					<p><strong>This is not actually an example.</strong> It is used by TypeDoc&#39;s tests. For example documentation <a href="https://typedoc.org/api/">https://typedoc.org/api/</a> is recommended.</p>
 				</blockquote>
 				<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
 					<h2>Installation</h2>