Merge pull request #266 from ember-nexus/github-issue/263

Streamline documentation, closes #263.

CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## Unreleased
 ### Changed
 - Update NGINX Unit build steps in Dockerfile, replace Mercurial repo with new GitHub repo. Closes #261.
+- Streamline documentation, closes #263.
 ### Removed
 - Remove supervisord and its dependencies like Python. Logs are directly sent to stderr. Closes #244.
 

docs/_sidebar.md

@@ -22,52 +22,52 @@
 - API Endpoints
 
   - **User Endpoints**
-    - [<span class="method-post">POST</span>` /register -` Register New Account](/api-endpoints/user/post-register)
-    - [<span class="method-post">POST</span>` /change-password -` Change Password](/api-endpoints/user/post-change-password)
-    - [<span class="method-get">GET</span>` /me -` Get Me](/api-endpoints/user/get-me)
-    - [<span class="method-post">POST</span>` /token -` Create Token](/api-endpoints/user/post-token)
-    - [<span class="method-get">GET</span>` /token -` Get Token](/api-endpoints/user/get-token)
-    - [<span class="method-delete">DELETE</span>` /token -` Delete Token](/api-endpoints/user/delete-token)
+    - [<span class="method-post">POST</span>` /register -` Register New Account Endpoint](/api-endpoints/user/post-register)
+    - [<span class="method-post">POST</span>` /change-password -` Change Password Endpoint](/api-endpoints/user/post-change-password)
+    - [<span class="method-get">GET</span>` /me -` Get Me Endpoint](/api-endpoints/user/get-me)
+    - [<span class="method-post">POST</span>` /token -` Create Token Endpoint](/api-endpoints/user/post-token)
+    - [<span class="method-get">GET</span>` /token -` Get Token Endpoint](/api-endpoints/user/get-token)
+    - [<span class="method-delete">DELETE</span>` /token -` Delete Token Endpoint](/api-endpoints/user/delete-token)
   - **Element Endpoints**
-    - [<span class="method-get">GET</span>` / -` Get Index](/api-endpoints/element/get-index)
-    - [<span class="method-get">GET</span>` /<uuid> -` Get Element](/api-endpoints/element/get-element)
-    - [<span class="method-get">GET</span>` /<uuid>/parents -` Get Parents](/api-endpoints/element/get-parents)
-    - [<span class="method-get">GET</span>` /<uuid>/children -` Get Children](/api-endpoints/element/get-children)
-    - [<span class="method-get">GET</span>` /<uuid>/related -` Get Related](/api-endpoints/element/get-related)
-    - [<span class="method-post">POST</span>` / -` Create Root Level Element](/api-endpoints/element/post-index)
-    - [<span class="method-post">POST</span>` /<uuid> -` Create Element](/api-endpoints/element/post-element)
-    - [<span class="method-put">PUT</span>` /<uuid> -` Replace Element](/api-endpoints/element/put-element)
-    - [<span class="method-patch">PATCH</span>` /<uuid> -` Update Element](/api-endpoints/element/patch-element)
-    - [<span class="method-delete">DELETE</span>` /<uuid> -` Delete Element](/api-endpoints/element/delete-element)
+    - [<span class="method-get">GET</span>` / -` Get Index Endpoint](/api-endpoints/element/get-index)
+    - [<span class="method-get">GET</span>` /<uuid> -` Get Element Endpoint](/api-endpoints/element/get-element)
+    - [<span class="method-get">GET</span>` /<uuid>/parents -` Get Parents Endpoint](/api-endpoints/element/get-parents)
+    - [<span class="method-get">GET</span>` /<uuid>/children -` Get Children Endpoint](/api-endpoints/element/get-children)
+    - [<span class="method-get">GET</span>` /<uuid>/related -` Get Related Endpoint](/api-endpoints/element/get-related)
+    - [<span class="method-post">POST</span>` / -` Create Root Level Element Endpoint](/api-endpoints/element/post-index)
+    - [<span class="method-post">POST</span>` /<uuid> -` Create Element Endpoint](/api-endpoints/element/post-element)
+    - [<span class="method-put">PUT</span>` /<uuid> -` Replace Element Endpoint](/api-endpoints/element/put-element)
+    - [<span class="method-patch">PATCH</span>` /<uuid> -` Update Element Endpoint](/api-endpoints/element/patch-element)
+    - [<span class="method-delete">DELETE</span>` /<uuid> -` Delete Element Endpoint](/api-endpoints/element/delete-element)
   - **File Endpoints**
-    - [<span class="method-get">🚧 GET</span>` /<uuid>/file -` Get Element File](/api-endpoints/file/get-element-file)
-    - [<span class="method-post">🚧 POST</span>` /<uuid>/file -` Create Element File](/api-endpoints/file/post-element-file)
-    - [<span class="method-put">🚧 PUT</span>` /<uuid>/file -` Replace Element File](/api-endpoints/file/put-element-file)
-    - [<span class="method-patch">🚧 PATCH</span>` /<uuid>/file -` Update Element File](/api-endpoints/file/patch-element-file)
-    - [<span class="method-delete">🚧 DELETE</span>` /<uuid>/file -` Delete Element File](/api-endpoints/file/delete-element-file)
+    - [<span class="method-get">🚧 GET</span>` /<uuid>/file -` Get Element File Endpoint](/api-endpoints/file/get-element-file)
+    - [<span class="method-post">🚧 POST</span>` /<uuid>/file -` Create Element File Endpoint](/api-endpoints/file/post-element-file)
+    - [<span class="method-put">🚧 PUT</span>` /<uuid>/file -` Replace Element File Endpoint](/api-endpoints/file/put-element-file)
+    - [<span class="method-patch">🚧 PATCH</span>` /<uuid>/file -` Update Element File Endpoint](/api-endpoints/file/patch-element-file)
+    - [<span class="method-delete">🚧 DELETE</span>` /<uuid>/file -` Delete Element File Endpoint](/api-endpoints/file/delete-element-file)
   - **WebDAV Endpoints**
-    - [<span class="method-copy">🚧 COPY</span>` /<uuid> -` Copy Element](/api-endpoints/webdav/copy-element)
-    - [<span class="method-lock">🚧 LOCK</span>` /<uuid> -` Lock Element](/api-endpoints/webdav/lock-element)
-    - [<span class="method-unlock">🚧 UNLOCK</span>` /<uuid> -` Unlock Element](/api-endpoints/webdav/unlock-element)
-    - [<span class="method-mkcol">🚧 MKCOL</span>` /<uuid> -` Create Folder](/api-endpoints/webdav/mkcol-folder)
-    - [<span class="method-move">🚧 MOVE</span>` /<uuid> -` Move Element](/api-endpoints/webdav/move-element)
-    - [<span class="method-propfind">🚧 PROPFIND</span>` /<uuid> -` Find Element Property](/api-endpoints/webdav/propfind-element)
-    - [<span class="method-proppatch">🚧 PROPPATCH</span>` /<uuid> -` Change Element Property](/api-endpoints/webdav/proppatch-element)
+    - [<span class="method-copy">🚧 COPY</span>` /<uuid> -` Copy Element Endpoint](/api-endpoints/webdav/copy-element)
+    - [<span class="method-lock">🚧 LOCK</span>` /<uuid> -` Lock Element Endpoint](/api-endpoints/webdav/lock-element)
+    - [<span class="method-unlock">🚧 UNLOCK</span>` /<uuid> -` Unlock Element Endpoint](/api-endpoints/webdav/unlock-element)
+    - [<span class="method-mkcol">🚧 MKCOL</span>` /<uuid> -` Create Folder Endpoint](/api-endpoints/webdav/mkcol-folder)
+    - [<span class="method-move">🚧 MOVE</span>` /<uuid> -` Move Element Endpoint](/api-endpoints/webdav/move-element)
+    - [<span class="method-propfind">🚧 PROPFIND</span>` /<uuid> -` Find Element Property Endpoint](/api-endpoints/webdav/propfind-element)
+    - [<span class="method-proppatch">🚧 PROPPATCH</span>` /<uuid> -` Change Element Property Endpoint](/api-endpoints/webdav/proppatch-element)
   - **Search Endpoints**
-    - [<span class="method-post">POST</span>` /search -` Search](/api-endpoints/search/post-search)
+    - [<span class="method-post">POST</span>` /search -` Search Endpoint](/api-endpoints/search/post-search)
   - **System Endpoints**
-    - [<span class="method-get">GET</span>` /instance-configuration -` Get Instance Configuration](/api-endpoints/system/get-instance-configuration)
-    - [<span class="method-get">GET</span>` /.well-known/security.txt -` Get Well Known security.txt](/api-endpoints/system/get-well-known-security-txt)
+    - [<span class="method-get">GET</span>` /instance-configuration -` Get Instance Configuration Endpoint](/api-endpoints/system/get-instance-configuration)
+    - [<span class="method-get">GET</span>` /.well-known/security.txt -` Get Well Known security.txt Endpoint](/api-endpoints/system/get-well-known-security-txt)
   - **Error Endpoints**
-    - [<span class="method-get">GET</span>` /error/400/bad-content`](/api-endpoints/error/get-400-bad-content)
-    - [<span class="method-get">GET</span>` /error/400/forbidden-property`](/api-endpoints/error/get-400-forbidden-property)
-    - [<span class="method-get">GET</span>` /error/400/incomplete-mutual-dependency`](/api-endpoints/error/get-400-incomplete-mutual-dependency)
-    - [<span class="method-get">GET</span>` /error/400/missing-property`](/api-endpoints/error/get-400-missing-property)
-    - [<span class="method-get">GET</span>` /error/400/reserved-identifier`](/api-endpoints/error/get-400-reserved-identifier)
-    - [<span class="method-get">GET</span>` /error/401/unauthorized`](/api-endpoints/error/get-401-unauthorized)
-    - [<span class="method-get">GET</span>` /error/403/forbidden`](/api-endpoints/error/get-403-forbidden)
-    - [<span class="method-get">GET</span>` /error/404/not-found`](/api-endpoints/error/get-404-not-found)
-    - [<span class="method-get">GET</span>` /error/501/not-implemented`](/api-endpoints/error/get-501-not-implemented)
+    - [<span class="method-get">GET</span>` /error/400/bad-content -` Get Details for Error 400 Bad Content Endpoint](/api-endpoints/error/get-400-bad-content)
+    - [<span class="method-get">GET</span>` /error/400/forbidden-property -` Get Details for Error 400 Forbidden Property Endpoint](/api-endpoints/error/get-400-forbidden-property)
+    - [<span class="method-get">GET</span>` /error/400/incomplete-mutual-dependency -` Get Details for Error 400 Incomplete Mutual Dependency Endpoint](/api-endpoints/error/get-400-incomplete-mutual-dependency)
+    - [<span class="method-get">GET</span>` /error/400/missing-property -` Get Details for Error 400 Missing Property Endpoint](/api-endpoints/error/get-400-missing-property)
+    - [<span class="method-get">GET</span>` /error/400/reserved-identifier -` Get Details for Error 400 Reserved Identifier Endpoint](/api-endpoints/error/get-400-reserved-identifier)
+    - [<span class="method-get">GET</span>` /error/401/unauthorized -` Get Details for Error 401 Unauthorized Endpoint](/api-endpoints/error/get-401-unauthorized)
+    - [<span class="method-get">GET</span>` /error/403/forbidden -` Get Details for Error 403 Forbidden Endpoint](/api-endpoints/error/get-403-forbidden)
+    - [<span class="method-get">GET</span>` /error/404/not-found -` Get Details for Error 404 Not Found Endpoint](/api-endpoints/error/get-404-not-found)
+    - [<span class="method-get">GET</span>` /error/501/not-implemented -` Get Details for Error 501 Not Implemented Endpoint](/api-endpoints/error/get-501-not-implemented)
 
 - Commands
   - **System Commands**

docs/api-endpoints/element/delete-element.md

@@ -1,4 +1,4 @@
-# <span class="method-delete">DELETE</span>` /<uuid> -` Delete Element
+# <span class="title-url"><span class="method-delete">DELETE</span>` /<uuid>`</span><span class="title-human">Delete Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/get-children.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /<uuid>/children -` Get Children
+# <span class="title-url"><span class="method-get">GET</span>` /<uuid>/children`</span><span class="title-human">Get Children Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/get-element.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /<uuid> -` Get Element
+# <span class="title-url"><span class="method-get">GET</span>` /<uuid>`</span><span class="title-human">Get Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/get-index.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` / -` Get Index
+# <span class="title-url"><span class="method-get">GET</span>` /`</span><span class="title-human">Get Index Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/get-parents.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /<uuid>/parents -` Get Parents
+# <span class="title-url"><span class="method-get">GET</span>` /<uuid>/parents`</span><span class="title-human">Get Parents Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/get-related.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /<uuid>/related -` Get Related
+# <span class="title-url"><span class="method-get">GET</span>` /<uuid>/related`</span><span class="title-human">Get Related Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/patch-element.md

@@ -1,4 +1,4 @@
-# <span class="method-patch">PATCH</span>` /<uuid> -` Update Element
+# <span class="title-url"><span class="method-patch">PATCH</span>` /<uuid>`</span><span class="title-human">Update Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/post-element.md

@@ -1,4 +1,4 @@
-# <span class="method-post">POST</span>` /<uuid> -` Create Element
+# <span class="title-url"><span class="method-post">POST</span>` /<uuid>`</span><span class="title-human">Create Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/post-index.md

@@ -1,4 +1,4 @@
-# <span class="method-post">POST</span>` / -` Create Root Level Element
+# <span class="title-url"><span class="method-post">POST</span>` /`</span><span class="title-human">Create Root Level Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/element/put-element.md

@@ -1,4 +1,4 @@
-# <span class="method-put">PUT</span>` /<uuid> -` Replace Element
+# <span class="title-url"><span class="method-put">PUT</span>` /<uuid>`</span><span class="title-human">Replace Element Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/error/get-400-bad-content.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/400/bad-content`
+# <span class="title-url"><span class="method-get">GET</span>` /error/400/bad-content`</span><span class="title-human">Get Details for Error 400 Bad Content Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-400-forbidden-property.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/400/forbidden-property`
+# <span class="title-url"><span class="method-get">GET</span>` /error/400/forbidden-property`</span><span class="title-human">Get Details for Error 400 Forbidden Property Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-400-incomplete-mutual-dependency.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/400/incomplete-mutual-dependency`
+# <span class="title-url"><span class="method-get">GET</span>` /error/400/incomplete-mutual-dependency`</span><span class="title-human">Get Details for Error 400 Incomplete Mutual Dependency Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-400-missing-property.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/400/missing-property`
+# <span class="title-url"><span class="method-get">GET</span>` /error/400/missing-property`</span><span class="title-human">Get Details for Error 400 Missing Property Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-400-reserved-identifier.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/400/reserved-identifier`
+# <span class="title-url"><span class="method-get">GET</span>` /error/400/reserved-identifier`</span><span class="title-human">Get Details for Error 400 Reserved Identifier Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-401-unauthorized.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/401/unauthorized`
+# <span class="title-url"><span class="method-get">GET</span>` /error/401/unauthorized`</span><span class="title-human">Get Details for Error 401 Unauthorized Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-403-forbidden.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/403/forbidden`
+# <span class="title-url"><span class="method-get">GET</span>` /error/403/forbidden`</span><span class="title-human">Get Details for Error 403 Forbidden Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-404-not-found.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/404/not-found`
+# <span class="title-url"><span class="method-get">GET</span>` /error/404/not-found`</span><span class="title-human">Get Details for Error 404 Not Found Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/error/get-501-not-implemented.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /error/501/not-implemented`
+# <span class="title-url"><span class="method-get">GET</span>` /error/501/not-implemented`</span><span class="title-human">Get Details for Error 501 Not Implemented Endpoint</span>
 
 ## Request Example
 

docs/api-endpoints/file/delete-element-file.md

@@ -1,4 +1,4 @@
-# <span class="method-delete">🚧 DELETE</span>` /<uuid>/file -` Delete Element File
+# <span class="title-url"><span class="method-delete">🚧 DELETE</span>` /<uuid>/file`</span><span class="title-human">Delete Element File Endpoint</span>
 
 !> **Currently not implemented.**  
 This feature is reserved for the version [0.2.0](https://github.com/ember-nexus/api/milestone/1).

docs/api-endpoints/file/get-element-file.md

@@ -1,4 +1,4 @@
-# <span class="method-get">🚧 GET</span>` /<uuid>/file -` Get Element File
+# <span class="title-url"><span class="method-get">🚧 GET</span>` /<uuid>/file`</span><span class="title-human">Get Element File Endpoint</span>
 
 !> **Currently not implemented.**  
 This feature is reserved for the version [0.2.0](https://github.com/ember-nexus/api/milestone/1).

docs/api-endpoints/file/patch-element-file.md

@@ -1,4 +1,4 @@
-# <span class="method-patch">🚧 PATCH</span>` /<uuid>/file -` Update Element File
+# <span class="title-url"><span class="method-patch">🚧 PATCH</span>` /<uuid>/file`</span><span class="title-human">Update Element File Endpoint</span>
 
 !> **Currently not implemented.**  
 This feature is reserved for the version [0.2.0](https://github.com/ember-nexus/api/milestone/1).

docs/api-endpoints/file/post-element-file.md

@@ -1,4 +1,4 @@
-# <span class="method-post">🚧 POST</span>` /<uuid>/file -` Create Element File
+# <span class="title-url"><span class="method-post">🚧 POST</span>` /<uuid>/file`</span><span class="title-human">Create Element File Endpoint</span>
 
 !> **Currently not implemented.**  
 This feature is reserved for the version [0.2.0](https://github.com/ember-nexus/api/milestone/1).

docs/api-endpoints/file/put-element-file.md

@@ -1,4 +1,4 @@
-# <span class="method-put">🚧 PUT</span>` /<uuid>/file -` Replace Element File
+# <span class="title-url"><span class="method-put">🚧 PUT</span>` /<uuid>/file`</span><span class="title-human">Replace Element File Endpoint</span>
 
 !> **Currently not implemented.**  
 This feature is reserved for the version [0.2.0](https://github.com/ember-nexus/api/milestone/1).

docs/api-endpoints/search/post-search.md

@@ -1,4 +1,4 @@
-# <span class="method-post">POST</span>` /search -` Search
+# <span class="title-url"><span class="method-post">POST</span>` /search`</span><span class="title-human">Search Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/system/get-instance-configuration.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /instance-configuration -` Get Instance Configuration
+# <span class="title-url"><span class="method-get">GET</span>` /instance-configuration`</span><span class="title-human">Get Instance Configuration Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/system/get-well-known-security-txt.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /.well-known/security.txt -` Get Well Known security.txt
+# <span class="title-url"><span class="method-get">GET</span>` /.well-known/security.txt`</span><span class="title-human">Get Well Known security.txt Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/user/delete-token.md

@@ -1,4 +1,4 @@
-# <span class="method-delete">DELETE</span>` /token -` Delete Token
+# <span class="title-url"><span class="method-delete">DELETE</span>` /token`</span><span class="title-human">Delete Token Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/user/get-me.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /me -` Get Me
+# <span class="title-url"><span class="method-get">GET</span>` /me`</span><span class="title-human">Get Me Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/user/get-token.md

@@ -1,4 +1,4 @@
-# <span class="method-get">GET</span>` /token -` Get Token
+# <span class="title-url"><span class="method-get">GET</span>` /token`</span><span class="title-human">Get Token Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/user/post-change-password.md

@@ -1,4 +1,4 @@
-# <span class="method-post">POST</span>` /change-password -` Change Password
+# <span class="title-url"><span class="method-post">POST</span>` /change-password`</span><span class="title-human">Change Password Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->

docs/api-endpoints/user/post-register.md

@@ -1,4 +1,4 @@
-# <span class="method-post">POST</span>` /register -` Register New Account
+# <span class="title-url"><span class="method-post">POST</span>` /register`</span><span class="title-human">Register New Account Endpoint</span>
 
 <!-- panels:start -->
 <!-- div:left-panel -->