diff --git a/docs/API Documentation.md b/docs/API Documentation.md index ed158a9..deb4f9a 100644 --- a/docs/API Documentation.md +++ b/docs/API Documentation.md @@ -1,14 +1,14 @@ -# API Introduction +# API Documentation The AccountHub API is extremely simple to use. Requests can be sent via GET or POST, and responses are sent in JSON. POST requests are strongly recommended over GET for security reasons (i.e. GET request data, including API keys and plaintext passwords, is saved in server logs and browser history with little to no protection). You should only use GET requests for debugging purposes or if (for some awful reason) it is not possible to use POST for your use case. -# Request Structure +## Request Structure The API is typically located at `http(s)://accounthub-url/api.php`. All requests to the API must include a `key` argument containing a valid API key. They must also include an `action`. The `action` specifies the type of request. Other arguments may or may not be needed, depending on the `action` specified. See the table below for valid actions and parameters. -# Response Structure +## Response Structure Responses to well-formed requests will have a `status` field containing the string `OK` or `ERROR`. If `status` is `ERROR`, there will also be a field named `msg` containing a human-readable localized error message suitable for display to the user. @@ -16,7 +16,7 @@ If `status` is `OK`, there may or may not be additional fields sent, depending o If the request is not well-formed (missing required arguments, invalid API key, or invalid `action`), the API will send a 4xx HTTP code and a JSON string, such as `"400 Bad Request"`, `"403 Unauthorized"`, or `"404 Not Found: the requested action is not available."`. -# Actions +## Actions | Action | Additional Arguments | Description | ------------- | --------------------------------------- | ----------- diff --git a/docs/System Requirements.md b/docs/System Requirements.md index 7197818..37d1c93 100644 --- a/docs/System Requirements.md +++ b/docs/System Requirements.md @@ -1,6 +1,6 @@ # System Requirements -Portal is tested and officially supported on the following configurations. Other systems may be supported at our discretion, possibly with an additional support fee. AccountHub and the other business apps should work on any sane Linux/PHP/SQL based web stack. +AccountHub (and the other Business Apps) are tested and officially supported on the following configurations. Other systems may be supported at our discretion, possibly with an additional support fee. AccountHub and the other business apps should work on any sane Linux/PHP/MySQL based web server, even if it is not within the requirements shown here. ## Server @@ -17,7 +17,7 @@ The Business Apps are very lightweight on server resources. The minimum support * 7.1 * Database * MySQL 5.7+ - * MariaDB 10.0/10.1 + * MariaDB 10.0+ * Web Server * Apache 2.4 @@ -42,7 +42,7 @@ Note: This list is incomplete, as any OS capable of running one of the browsers * Ubuntu Derivatives (such as Linux Mint) * Debian 8 or 9 * Android - * 5.0 - 7.0 with Chrome, or + * 5.0+ with Chrome, or * Any supported by Firefox, or * Any supported by the Business Apps for Mobile client @@ -55,7 +55,7 @@ All screens with a viewport (the portion of the screen showing the app, in contr ### Supported Web Browsers * Mozilla Firefox (54+) * Chrome/Chromium (latest and latest-1) -* Android WebView (Android 5+) +* Chrome WebView, AOSP WebView (Android 5.0+) ### Unsupported Web Browsers While we do not support the following browsers, they will likely still work. You won't break anything by trying. diff --git a/docs/images/docs-icon.svg b/docs/images/docs-icon.svg new file mode 100644 index 0000000..2912202 --- /dev/null +++ b/docs/images/docs-icon.svg @@ -0,0 +1,117 @@ + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + diff --git a/mkdocs.yml b/mkdocs.yml index 68e3840..549ef5a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ site_name: AccountHub Docs theme: name: 'material' logo: 'images/logo.svg' + favicon: 'images/docs-icon.svg' feature: tabs: false palette: