Work on the getting started page

Elfocrash · Nov 30, 2018 · ddacd7e · ddacd7e
1 parent ce69e0b
commit ddacd7e
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 1 deletion.
diff --git a/docs/Getting-started.md b/docs/Getting-started.md
@@ -0,0 +1,13 @@
+# Getting Started Guide
+
+## What is Cosmonaut?
+
+Cosmonaut is a supercharged Azure CosmosD DB SDK for the SQL API with ORM support. It eliminates the need for most of the data-access code that developers usually need to write and it limits the unit of work scope to the object itself that the developer needs to work with.
+
+## Why use Cosmonaut?
+
+The official Cosmos DB SDK has a ton of features and it can do a lot of things, but there is no clear path when it comes to doing those things. There is object mapping but the scope always stays the same.
+
+Cosmonaut limits the scope from the Database account level to the `CosmosStore`. The `CosmosStore`'s context is a single collection or part of a collection when using the collection sharing feature. That way, we have an entry point with a single responsibility and authority to operate to only what it needs to know about.
+
+## How do I use Cosmonaut
diff --git a/docs/What-is-Cosmonaut.md b/docs/What-is-Cosmonaut.md
diff --git a/docs/index.rst b/docs/index.rst
@@ -6,9 +6,11 @@
 Welcome to Cosmonaut's documentation!
 =====================================
 
+.. _user-docs:
+
 .. toctree::
    :hidden:
    :maxdepth: 2
    :caption: User Documentation
 
-   What-is-Cosmonaut
+   Getting-started