update docs -1

Author: jaredcnance

docs/.gitignore

@@ -0,0 +1 @@
+_site/

docs/GET_Articles_Response

@@ -0,0 +1 @@
+{"data":[]}

docs/api/.gitignore

@@ -0,0 +1,4 @@
+###############
+#  temp file  #
+###############
+*.yml

src/JsonApiDotNetCore/api/.manifest renamed to docs/api/.manifest

@@ -3,8 +3,8 @@
         {
             "src": [
                 {
-                    "files": [ "**.csproj" ],
-                    "src": "C:\\Users\\jnance\\dev\\json-api-dotnet-core\\src\\JsonApiDotNetCore"
+                    "files": [ "**/JsonApiDotNetCore.csproj" ],
+                    "src": "../"
                 }
             ],
             "dest": "api",
@@ -21,8 +21,9 @@
             },
             {
                 "files": [
-                    "articles/**.md",
-                    "articles/**/toc.yml",
+                    "getting-started/**.md",
+                    "getting-started/**/toc.yml",
+                    "request-examples/**.md",
                     "toc.yml",
                     "*.md"
                 ]

src/JsonApiDotNetCore/api/index.md renamed to docs/api/index.md

@@ -0,0 +1,29 @@
+#!/bin/bash
+# generates ./request-examples documents
+
+function cleanup() {
+    kill -9 $(lsof -ti tcp:5001) &2>/dev/null
+}
+
+cleanup
+dotnet run -p ../src/Examples/GettingStarted/GettingStarted.csproj &
+app_pid=$!
+
+
+{ # try
+    echo "Started app with PID $app_pid"
+
+    sleep 5
+
+    echo "sleep over"
+
+    for path in ./request-examples/*.sh; do
+        op_name=$(basename "$path" .sh | sed 's/.*-//')
+        echo $op_name
+        bash $path | jq . > "./request-examples/$op_name-Response.json"
+    done
+}
+
+# docfx metadata
+
+cleanup

src/JsonApiDotNetCore/docfx.json renamed to docs/docfx.json

@@ -0,0 +1,9 @@
+## Installing
+
+...
+
+## Creating a project template
+
+```
+dotnet new jadnc
+```

docs/generate.sh

@@ -0,0 +1,5 @@
+# Introduction
+
+What is this
+
+[!code-csharp[Main](../../src/Examples/OperationsExample/Program.cs)]

docs/generators/index.md

@@ -0,0 +1,36 @@
+# JSON API .Net Core
+
+A [{ json:api }](https://jsonapi.org) web application framework for .Net Core.
+
+## Objectives
+
+### 1. Eliminate Boilerplate
+
+The goal of this package is to facility the development of json:api applications that leverage the full range 
+of features provided by the specification.
+
+Eliminate CRUD boilerplate and provide the following features across all your resource endpoints: 
+
+- Relationship inclusion and navigation
+- Filtering
+- Sorting
+- Pagination
+- Sparse field selection
+- And more...
+
+As an example, with just the following model and controller definitions, you can service all of the following requests:
+
+```http
+GET /articles HTTP/1.1
+Accept: application/vnd.api+json
+```
+
+[!code-csharp[Article](../src/Examples/GettingStarted/Models/Article.cs)]
+
+[!code-csharp[ArticlesController](../src/Examples/GettingStarted/Controllers/ArticlesController.cs)]
+
+### 2. Extensibility
+
+This library relies heavily on an open-generic-based dependency injection model which allows for easy per-resource customization.
+
+

docs/getting-started/intro.md

@@ -0,0 +1 @@
+*.json

src/JsonApiDotNetCore/articles/toc.yml renamed to docs/getting-started/toc.yml

@@ -0,0 +1,11 @@
+curl http://localhost:5001/api/articles         \
+    -H "Accept: application/vnd.api+json"       \
+    -H "Content-Type: application/vnd.api+json" \
+    -d '{
+            "data": {
+                "type": "articles",
+                "attributes": {
+                    "title": "test"
+                }
+            }
+        }'

docs/index.md

@@ -0,0 +1,2 @@
+curl http://localhost:5001/api/articles     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/.gitignore

@@ -0,0 +1,2 @@
+curl http://localhost:5001/api/articles/1     \
+    -H "Accept: application/vnd.api+json"

docs/request-examples/000-CREATE_Article.sh

@@ -0,0 +1,19 @@
+# Examples
+
+These requests have been generated against the "GettingStarted" application and are updated on every deployment.
+
+## Create Article
+
+[!code-sh[CREATE](000-CREATE_Article.sh)]
+[!code-json[CREATE](CREATE_Article-Response.json)]
+
+
+## Get All Articles
+
+[!code-sh[GET Request](001-GET_Articles.sh)]
+[!code-json[GET Response](GET_Articles-Response.json)]
+
+## Get Article By Id
+
+[!code-sh[GET Request](002-GET_Article.sh)]
+[!code-json[GET Response](GET_Article-Response.json)]

docs/request-examples/001-GET_Articles.sh

@@ -0,0 +1,10 @@
+- name: Getting Started
+  href: getting-started/
+  
+- name: API
+  href: api/
+  homepage: api/index.md
+
+- name: Request Examples
+  href: request-examples/
+  homepage: request-examples/index.md

docs/request-examples/002-GET_Article.sh

@@ -1,12 +1,11 @@
 using JsonApiDotNetCore.Models;
-
 namespace GettingStarted.Models
 {
     public class Article : Identifiable
     {
         [Attr("title")]
         public string Title { get; set; }
-
+        
         [HasOne("author")]
         public Person Author { get; set; }
         public int AuthorId { get; set; }