GITBOOK-20: readme resolved and adjusted layout

Jordan-Prescott · Jan 4, 2024 · 0a4943e · 0a4943e
1 parent b6d9243
commit 0a4943e
Show file tree

Hide file tree

Showing 29 changed files with 36 additions and 41 deletions.
diff --git a/README (1).md b/README (1).md
diff --git a/README.md b/README.md
@@ -1,2 +1,7 @@
-# 📄 README.md
+# 👋 Welcome!!
 
+Welcome to odin\_api a Python library to ease the use of Odins API(naming on point). Odin is a solution by [rev.io](https://rev.io/) for managing Broadworks instances. The library eases the use of this API and encapsulates the methods available.&#x20;
+
+## Odin API Docs:
+
+{% embed url="https://doc.odinapi.net/" %}
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -1,29 +1,29 @@
 # Table of contents
 
-* [📄 README.md](README.md)
-* [👋 Welcome!!](<README (1).md>)
-  * [🧐 Getting Started](welcome/getting-started/README.md)
-    * [🐍 Getting the Essentials (Python + IDE)](welcome/getting-started/getting-the-essentials-python-+-ide.md)
-    * [⚠ Setting Environment Variable](welcome/getting-started/setting-environment-variable.md)
-    * [⬇ Downloading Library (BETA)](welcome/getting-started/downloading-library-beta.md)
-    * [⚙ Create API Object](welcome/getting-started/create-api-object.md)
-  * [📦 Methods](welcome/methods/README.md)
-    * [📥 Get](welcome/methods/get.md)
-    * [✉ Post](welcome/methods/post.md)
-    * [📤 Put](welcome/methods/put.md)
-    * [🚮 Delete](welcome/methods/delete.md)
-  * [🙌 Features](welcome/features/README.md)
-    * [🤖 Scripter](welcome/features/scripter/README.md)
-      * [🔎 Find Alias (Script)](welcome/features/scripter/find-alias-script.md)
-  * [🖌 Library Design](welcome/library-design/README.md)
-    * [🔗 Object Relationship](welcome/library-design/object-relationship.md)
-    * [⚙ API Object](welcome/library-design/api-object.md)
-    * [📥 Get Object](welcome/library-design/get-object.md)
-    * [✉ Post Object](welcome/library-design/post-object.md)
-    * [📤 Put Object](welcome/library-design/put-object.md)
-    * [🚮 Delete Object](welcome/library-design/delete-object.md)
-    * [❓ Requester Object](welcome/library-design/requester-object.md)
-    * [🤖 Scripter Object](welcome/library-design/scripter-object.md)
-  * [👨💻 Development](welcome/development.md)
-  * [📢 Feedback](welcome/feedback.md)
-  * [🤙 Contact](welcome/contact.md)
+* [👋 Welcome!!](README.md)
+* [📖 Docs](docs/README.md)
+  * [🧐 Getting Started](docs/getting-started/README.md)
+    * [🐍 Getting the Essentials (Python + IDE)](docs/getting-started/getting-the-essentials-python-+-ide.md)
+    * [⚠ Setting Environment Variable](docs/getting-started/setting-environment-variable.md)
+    * [⬇ Downloading Library (BETA)](docs/getting-started/downloading-library-beta.md)
+    * [⚙ Create API Object](docs/getting-started/create-api-object.md)
+  * [📦 Methods](docs/methods/README.md)
+    * [📥 Get](docs/methods/get.md)
+    * [✉ Post](docs/methods/post.md)
+    * [📤 Put](docs/methods/put.md)
+    * [🚮 Delete](docs/methods/delete.md)
+  * [🙌 Features](docs/features/README.md)
+    * [🤖 Scripter](docs/features/scripter/README.md)
+      * [🔎 Find Alias (Script)](docs/features/scripter/find-alias-script.md)
+  * [🖌 Library Design](docs/library-design/README.md)
+    * [🔗 Object Relationship](docs/library-design/object-relationship.md)
+    * [⚙ API Object](docs/library-design/api-object.md)
+    * [📥 Get Object](docs/library-design/get-object.md)
+    * [✉ Post Object](docs/library-design/post-object.md)
+    * [📤 Put Object](docs/library-design/put-object.md)
+    * [🚮 Delete Object](docs/library-design/delete-object.md)
+    * [❓ Requester Object](docs/library-design/requester-object.md)
+    * [🤖 Scripter Object](docs/library-design/scripter-object.md)
+* [👨💻 Development](development.md)
+* [🤙 Contact](contact/README.md)
+  * [📢 Feedback](contact/feedback.md)
diff --git a/welcome/contact.md → contact/README.md b/welcome/contact.md → contact/README.md
diff --git a/welcome/feedback.md → contact/feedback.md b/welcome/feedback.md → contact/feedback.md
diff --git a/welcome/development.md → development.md b/welcome/development.md → development.md
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,3 @@
+# 📖 Docs
+
+How to, what's this, and does it do that all answered in the next sections.
diff --git a/welcome/features/README.md → docs/features/README.md b/welcome/features/README.md → docs/features/README.md
diff --git a/welcome/features/scripter/README.md → docs/features/scripter/README.md b/welcome/features/scripter/README.md → docs/features/scripter/README.md
diff --git a/...me/features/scripter/find-alias-script.md → docs/features/scripter/find-alias-script.md b/...me/features/scripter/find-alias-script.md → docs/features/scripter/find-alias-script.md
diff --git a/welcome/getting-started/README.md → docs/getting-started/README.md b/welcome/getting-started/README.md → docs/getting-started/README.md
diff --git a/welcome/getting-started/create-api-object.md → docs/getting-started/create-api-object.md b/welcome/getting-started/create-api-object.md → docs/getting-started/create-api-object.md
diff --git a/...tting-started/downloading-library-beta.md → ...tting-started/downloading-library-beta.md b/...tting-started/downloading-library-beta.md → ...tting-started/downloading-library-beta.md
diff --git a/...ed/getting-the-essentials-python-+-ide.md → ...ed/getting-the-essentials-python-+-ide.md b/...ed/getting-the-essentials-python-+-ide.md → ...ed/getting-the-essentials-python-+-ide.md
diff --git a/...g-started/setting-environment-variable.md → ...g-started/setting-environment-variable.md b/...g-started/setting-environment-variable.md → ...g-started/setting-environment-variable.md
diff --git a/welcome/library-design/README.md → docs/library-design/README.md b/welcome/library-design/README.md → docs/library-design/README.md
diff --git a/welcome/library-design/api-object.md → docs/library-design/api-object.md b/welcome/library-design/api-object.md → docs/library-design/api-object.md
diff --git a/welcome/library-design/delete-object.md → docs/library-design/delete-object.md b/welcome/library-design/delete-object.md → docs/library-design/delete-object.md
diff --git a/welcome/library-design/get-object.md → docs/library-design/get-object.md b/welcome/library-design/get-object.md → docs/library-design/get-object.md
diff --git a/...ome/library-design/object-relationship.md → docs/library-design/object-relationship.md b/...ome/library-design/object-relationship.md → docs/library-design/object-relationship.md
diff --git a/welcome/library-design/post-object.md → docs/library-design/post-object.md b/welcome/library-design/post-object.md → docs/library-design/post-object.md
diff --git a/welcome/library-design/put-object.md → docs/library-design/put-object.md b/welcome/library-design/put-object.md → docs/library-design/put-object.md
diff --git a/welcome/library-design/requester-object.md → docs/library-design/requester-object.md b/welcome/library-design/requester-object.md → docs/library-design/requester-object.md
diff --git a/welcome/library-design/scripter-object.md → docs/library-design/scripter-object.md b/welcome/library-design/scripter-object.md → docs/library-design/scripter-object.md
diff --git a/welcome/methods/README.md → docs/methods/README.md b/welcome/methods/README.md → docs/methods/README.md
diff --git a/welcome/methods/delete.md → docs/methods/delete.md b/welcome/methods/delete.md → docs/methods/delete.md
diff --git a/welcome/methods/get.md → docs/methods/get.md b/welcome/methods/get.md → docs/methods/get.md
diff --git a/welcome/methods/post.md → docs/methods/post.md b/welcome/methods/post.md → docs/methods/post.md
diff --git a/welcome/methods/put.md → docs/methods/put.md b/welcome/methods/put.md → docs/methods/put.md