Add documentation-structure

Add first-documentation-example

Author: FawzyMokhtar

src/assets/data/data.json

@@ -0,0 +1,22 @@
+{
+    "$schema": "../schema/db.schema.json",
+    "versions": [
+        {
+            "version": "1.0.0",
+            "isLatest": true,
+            "groups": [
+                {
+                    "title": "Introduction",
+                    "posts": [
+                        {
+                            "id": "getting-started",
+                            "title": "Getting Started",
+                            "fileName": "getting-started.html",
+                            "sections": []
+                        }
+                    ]
+                }
+            ]
+        }
+    ]
+}

src/assets/docs/1.0.0/getting-started.html

@@ -0,0 +1 @@
+<span>Some text.......................</span>

src/assets/schema/db.schema.json

@@ -0,0 +1,18 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "The documentation database",
+    "description": "Defines the structure of the documentation versions",
+    "type": "object",
+    "properties": {
+        "versions": {
+            "type": "array",
+            "items": {
+                "$ref": "./documentation-version.schema.json"
+            },
+            "description": "The versions of the documentation"
+        }
+    },
+    "required": [
+        "versions"
+    ]
+}

src/assets/schema/documentation-version.schema.json

@@ -0,0 +1,30 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Documentation version",
+    "description": "Defines a new documentation version",
+    "type": "object",
+    "properties": {
+        "version": {
+            "type": "string",
+            "pattern": "^([0-9].){2}[0-9]$",
+            "description": "The version of the documentation"
+        },
+        "isLatest": {
+            "type": "boolean",
+            "description": "Indicates wether this is the latest version to use it as the default documentation",
+            "const": true
+        },
+        "groups": {
+            "type": "array",
+            "items": {
+                "$ref": "./post-group.schema.json"
+            },
+            "minItems": 1,
+            "description": "An array of documentation post groups"
+        }
+    },
+    "required": [
+        "version",
+        "groups"
+    ]
+}

src/assets/schema/post-group.schema.json

@@ -0,0 +1,24 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Documentation posts group",
+    "description": "Contains a set of documentation posts",
+    "type": "object",
+    "properties": {
+        "title": {
+            "type": "string",
+            "description": "The title of the documentation post group"
+        },
+        "posts": {
+            "type": "array",
+            "items": {
+                "$ref": "./post.schema.json"
+            },
+            "minItems": 1,
+            "description": "An array of documentation posts"
+        }
+    },
+    "required": [
+        "title",
+        "posts"
+    ]
+}

src/assets/schema/post.schema.json

@@ -0,0 +1,33 @@
+{
+    "$schema": "http://json-schema.org/draft-07/schema#",
+    "title": "Documentation post",
+    "description": "Contains all data associated with a documentation post",
+    "type": "object",
+    "properties": {
+        "id": {
+            "type": "string",
+            "description": "A unique identifier to use as a routeUrl"
+        },
+        "title": {
+            "type": "string",
+            "description": "The title of the documentation post"
+        },
+        "sections": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            },
+            "uniqueItems": true,
+            "description": "An array of the sections which included in the post body"
+        },
+        "fileName": {
+            "type": "string",
+            "description": "The url for the post body Html file"
+        }
+    },
+    "required": [
+        "id",
+        "title",
+        "fileName"
+    ]
+}