quickstart documentation revamp project

adopted-ember-addons · Jun 26, 2022 · 5e22d1a · 5e22d1a
1 parent 160aec8
commit 5e22d1a
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,2 @@
+- Getting started
+  - [Overview](overview.md)
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <title>Document</title>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="description" content="Description" />
+    <meta
+      name="viewport"
+      content="width=device-width, initial-scale=1.0, minimum-scale=1.0"
+    />
+    <link
+      rel="stylesheet"
+      href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css"
+    />
+  </head>
+  <body>
+    <div id="app"></div>
+    <script>
+      window.$docsify = {
+        name: 'Ember Data Factory Guy',
+        repo: 'https://github.com/adopted-ember-addons/ember-data-factory-guy',
+        loadSidebar: true,
+        subMaxLevel: 3,
+      };
+    </script>
+    <!-- Docsify v4 -->
+    <script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+    <script src="//cdn.jsdelivr.net/npm/docsify-copy-code"></script>
+    <script src="https://cdn.jsdelivr.net/npm/docsify-tabs@1"></script>
+  </body>
+</html>
diff --git a/docs/overview.md b/docs/overview.md
@@ -0,0 +1,7 @@
+[![Build Status](https://github.com/adopted-ember-addons/ember-data-factory-guy/actions/workflows/ci.yml/badge.svg)](https://github.com/adopted-ember-addons/ember-data-factory-guy/actions/workflows/ci.yml) [![Ember Observer Score](http://emberobserver.com/badges/ember-data-factory-guy.svg)](http://emberobserver.com/addons/ember-data-factory-guy) [![npm version](https://badge.fury.io/js/ember-data-factory-guy.svg)](http://badge.fury.io/js/ember-data-factory-guy)
+
+# Overview
+
+Feel the thrill and enjoyment of testing when using Factories instead of Fixtures.
+Factories simplify the process of testing, making you more efficient and your tests more readable.
+