diff --git a/README (1).md b/README (1).md deleted file mode 100644 index 6e8a8c2..0000000 --- a/README (1).md +++ /dev/null @@ -1,13 +0,0 @@ -# 👋 Welcome!! - -For those viewing this on GitHub and thinks this README.md file looks funky, the docs are on gitbook [here](https://docs.jordan-prescott.com/odin\_api/). - - - -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. - - - -## Odin API Documentation: - -{% embed url="https://doc.odinapi.net/" %} diff --git a/README.md b/README.md index 5393ae7..04ba872 100644 --- 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. + +## Odin API Docs: + +{% embed url="https://doc.odinapi.net/" %} diff --git a/SUMMARY.md b/SUMMARY.md index 7e355ea..491395e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -1,29 +1,29 @@ # Table of contents -* [📄 README.md](README.md) -* [👋 Welcome!!]() - * [🧐 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 b/contact/README.md similarity index 100% rename from welcome/contact.md rename to contact/README.md diff --git a/welcome/feedback.md b/contact/feedback.md similarity index 100% rename from welcome/feedback.md rename to contact/feedback.md diff --git a/welcome/development.md b/development.md similarity index 100% rename from welcome/development.md rename to development.md diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 0000000..336a769 --- /dev/null +++ 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 b/docs/features/README.md similarity index 100% rename from welcome/features/README.md rename to docs/features/README.md diff --git a/welcome/features/scripter/README.md b/docs/features/scripter/README.md similarity index 100% rename from welcome/features/scripter/README.md rename to docs/features/scripter/README.md diff --git a/welcome/features/scripter/find-alias-script.md b/docs/features/scripter/find-alias-script.md similarity index 100% rename from welcome/features/scripter/find-alias-script.md rename to docs/features/scripter/find-alias-script.md diff --git a/welcome/getting-started/README.md b/docs/getting-started/README.md similarity index 100% rename from welcome/getting-started/README.md rename to docs/getting-started/README.md diff --git a/welcome/getting-started/create-api-object.md b/docs/getting-started/create-api-object.md similarity index 100% rename from welcome/getting-started/create-api-object.md rename to docs/getting-started/create-api-object.md diff --git a/welcome/getting-started/downloading-library-beta.md b/docs/getting-started/downloading-library-beta.md similarity index 100% rename from welcome/getting-started/downloading-library-beta.md rename to docs/getting-started/downloading-library-beta.md diff --git a/welcome/getting-started/getting-the-essentials-python-+-ide.md b/docs/getting-started/getting-the-essentials-python-+-ide.md similarity index 100% rename from welcome/getting-started/getting-the-essentials-python-+-ide.md rename to docs/getting-started/getting-the-essentials-python-+-ide.md diff --git a/welcome/getting-started/setting-environment-variable.md b/docs/getting-started/setting-environment-variable.md similarity index 100% rename from welcome/getting-started/setting-environment-variable.md rename to docs/getting-started/setting-environment-variable.md diff --git a/welcome/library-design/README.md b/docs/library-design/README.md similarity index 100% rename from welcome/library-design/README.md rename to docs/library-design/README.md diff --git a/welcome/library-design/api-object.md b/docs/library-design/api-object.md similarity index 100% rename from welcome/library-design/api-object.md rename to docs/library-design/api-object.md diff --git a/welcome/library-design/delete-object.md b/docs/library-design/delete-object.md similarity index 100% rename from welcome/library-design/delete-object.md rename to docs/library-design/delete-object.md diff --git a/welcome/library-design/get-object.md b/docs/library-design/get-object.md similarity index 100% rename from welcome/library-design/get-object.md rename to docs/library-design/get-object.md diff --git a/welcome/library-design/object-relationship.md b/docs/library-design/object-relationship.md similarity index 100% rename from welcome/library-design/object-relationship.md rename to docs/library-design/object-relationship.md diff --git a/welcome/library-design/post-object.md b/docs/library-design/post-object.md similarity index 100% rename from welcome/library-design/post-object.md rename to docs/library-design/post-object.md diff --git a/welcome/library-design/put-object.md b/docs/library-design/put-object.md similarity index 100% rename from welcome/library-design/put-object.md rename to docs/library-design/put-object.md diff --git a/welcome/library-design/requester-object.md b/docs/library-design/requester-object.md similarity index 100% rename from welcome/library-design/requester-object.md rename to docs/library-design/requester-object.md diff --git a/welcome/library-design/scripter-object.md b/docs/library-design/scripter-object.md similarity index 100% rename from welcome/library-design/scripter-object.md rename to docs/library-design/scripter-object.md diff --git a/welcome/methods/README.md b/docs/methods/README.md similarity index 100% rename from welcome/methods/README.md rename to docs/methods/README.md diff --git a/welcome/methods/delete.md b/docs/methods/delete.md similarity index 100% rename from welcome/methods/delete.md rename to docs/methods/delete.md diff --git a/welcome/methods/get.md b/docs/methods/get.md similarity index 100% rename from welcome/methods/get.md rename to docs/methods/get.md diff --git a/welcome/methods/post.md b/docs/methods/post.md similarity index 100% rename from welcome/methods/post.md rename to docs/methods/post.md diff --git a/welcome/methods/put.md b/docs/methods/put.md similarity index 100% rename from welcome/methods/put.md rename to docs/methods/put.md