diff --git a/docs/app/connect.md b/docs/app/connect.md index 410e1fd..56c1cb8 100644 --- a/docs/app/connect.md +++ b/docs/app/connect.md @@ -47,7 +47,7 @@ Alternatively, long press on the server profile to activate the context menu, th When the app successfully connects to the server, a success message is briefly displayed at the bottom of the screen. A green icon next to the server profile indicate that the profile is currently *selected* and also the connection was successful. -{% with id="connected", url="app/connected.jpg", maxheight="240px", description="Connected to server" %} +{% with id="connected", url="app/connected.png", maxheight="240px", description="Connected to server" %} {% include 'img.html' %} {% endwith %} @@ -55,7 +55,7 @@ When the app successfully connects to the server, a success message is briefly d If (for whatever reason) the app does not successfully connect to the InvenTree server, a failure message is displayed, and a red icon is displayed next to the server profile. -{% with id="failed", url="app/unauthorized.jpg", maxheight="240px", description="Connection failure" %} +{% with id="failed", url="app/unauthorized.png", maxheight="240px", description="Connection failure" %} {% include 'img.html' %} {% endwith %} @@ -63,7 +63,7 @@ In this case, the error message displayed at the bottom of the screen provides c To edit the server profile details, long press on the server profile, and select *Edit Server Profile*: -{% with id="edit", url="app/edit_server.jpg", maxheight="240px", description="Edit server profile" %} +{% with id="edit", url="app/edit_server.png", maxheight="240px", description="Edit server profile" %} {% include 'img.html' %} {% endwith %} @@ -107,18 +107,6 @@ Select the *Stock* icon to open the [stock display](./stock.md). This initially Select the *Purchase Orders* icon to open the [purchase orders display](./po.md). This shows a list of currently outstanding purchase orders, allowing line items to be received into stock. -### Suppliers - -Select the *Suppliers* icon to display the list of available suppliers - -### Manufacturers - -Select the *Manufacturers* icon to display the list of available manufacturers - -### Customers - -Select the *Customers* icon to display the list of available customers - ### Settings Select the *Settings* icon to open the [settings display](./settings.md) diff --git a/docs/app/issues.md b/docs/app/issues.md index e50fbf3..b312a9e 100644 --- a/docs/app/issues.md +++ b/docs/app/issues.md @@ -4,10 +4,6 @@ title: App Suggestions / Issues ## Suggestions / Issues -To suggest an improvement or new feature for the InvenTree app, or to report an issue, refer to the [InvenTree GitHub page](https://github.com/inventree/inventree/issues). - -Suggestions or issues related to the InvenTree app will be tagged with the `app` label, and can be viewed here: - -[https://github.com/inventree/InvenTree/issues?q=is:open+is:issue+label:app](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aapp) +To suggest an improvement or new feature for the InvenTree app, or to report an issue, refer to the [InvenTree GitHub page](https://github.com/inventree/inventree-app/issues). General feedback on the app is also welcomed - if you have any ideas on how to make the app more functional or effective, please let us know! \ No newline at end of file diff --git a/docs/app/settings.md b/docs/app/settings.md index 723c604..03537c2 100644 --- a/docs/app/settings.md +++ b/docs/app/settings.md @@ -9,11 +9,18 @@ The *Settings* view provides access to user configurable settings, in addition t The main settings view is shown below, and provides the following options: - **Server** - Configure and select server profile +- **Home Screen** - Configure home screen settings - **App Settings** - Configure app settings -- **About** - Information about the InvenTree app -- **Documentation** - Opens the InvenTree documentation in an external browser -{% with id="settings_view", url="app/settings.jpg", maxheight="240px", description="Settings view" %} +{% with id="settings_view", url="app/settings.png", maxheight="240px", description="Settings view" %} +{% include 'img.html' %} +{% endwith %} + +## Home Screen + +The *Home Screen* view allows you to configure display options for the app 'home screen': + +{% with id="home_settings", url="app/home_settings.png", maxheight="240px", description="Home Screen Settings" %} {% include 'img.html' %} {% endwith %} @@ -21,10 +28,23 @@ The main settings view is shown below, and provides the following options: The *App Settings* view provides configuration options for the InvenTree app: -{% with id="app_settings", url="app/app_settings.jpg", maxheight="240px", description="App Settings" %} +{% with id="app_settings", url="app/app_settings.png", maxheight="240px", description="App Settings" %} {% include 'img.html' %} {% endwith %} +### Parts + +Configure options for "parts" display: + +- **Include Subcategories** - When viewing a list of parts in a category, include parts from subcategories + +### Stock + +Configure options for "stock" display: + +- **Include Sublocations** - When viewing a list of stock items in a location, include items from sublocations +- **Stock History** - Display stock item history in the stock detail view + ### Sounds Configure audible app notifications: @@ -32,23 +52,7 @@ Configure audible app notifications: - **Server Error** - Play an audible tone when a server error occurs - **Barcode Tones** - Play audible tones when scanning barcodes -## About +### App Settings -The *About* view provides details about the app itself: - -{% with id="about_app", url="app/about.jpg", maxheight="240px", description="About the InvenTree app" %} -{% include 'img.html' %} -{% endwith %} - -### Server Details - -- **Address** - URL of the currently connected server -- **Version** - Version of InvenTree software running on the server -- **Server Instance** - Instance name of the server - -### App Details - -- **Package Name** - Package identifier for the compiled app -- **Version** - App software version -- **Release Notes** - Select to view app release notes -- **Credits** - Select to view additional app credits +- **Use Strict HTTPS** - Enforce strict checking of HTTPs certificates. Enabling this option may prevent you from connecting to the server if there are certificate issues +- **Upload Error Reports** - Enable uploading of anonymous error / crash reports. These reports are used to improve the quality of the app. \ No newline at end of file diff --git a/docs/assets/images/app/about.jpg b/docs/assets/images/app/about.jpg deleted file mode 100644 index 82fdfac..0000000 Binary files a/docs/assets/images/app/about.jpg and /dev/null differ diff --git a/docs/assets/images/app/add_server_profile.png b/docs/assets/images/app/add_server_profile.png index 9bce796..21d48f3 100644 Binary files a/docs/assets/images/app/add_server_profile.png and b/docs/assets/images/app/add_server_profile.png differ diff --git a/docs/assets/images/app/app_settings.jpg b/docs/assets/images/app/app_settings.jpg deleted file mode 100644 index 18acd57..0000000 Binary files a/docs/assets/images/app/app_settings.jpg and /dev/null differ diff --git a/docs/assets/images/app/app_settings.png b/docs/assets/images/app/app_settings.png new file mode 100644 index 0000000..652ef6a Binary files /dev/null and b/docs/assets/images/app/app_settings.png differ diff --git a/docs/assets/images/app/connected.jpg b/docs/assets/images/app/connected.jpg deleted file mode 100644 index 52675ad..0000000 Binary files a/docs/assets/images/app/connected.jpg and /dev/null differ diff --git a/docs/assets/images/app/connected.png b/docs/assets/images/app/connected.png new file mode 100644 index 0000000..689a123 Binary files /dev/null and b/docs/assets/images/app/connected.png differ diff --git a/docs/assets/images/app/edit_server.jpg b/docs/assets/images/app/edit_server.jpg deleted file mode 100644 index 925bdc6..0000000 Binary files a/docs/assets/images/app/edit_server.jpg and /dev/null differ diff --git a/docs/assets/images/app/edit_server.png b/docs/assets/images/app/edit_server.png new file mode 100644 index 0000000..8b8e21f Binary files /dev/null and b/docs/assets/images/app/edit_server.png differ diff --git a/docs/assets/images/app/home.png b/docs/assets/images/app/home.png index 5c06227..0a72fdd 100644 Binary files a/docs/assets/images/app/home.png and b/docs/assets/images/app/home.png differ diff --git a/docs/assets/images/app/home_settings.png b/docs/assets/images/app/home_settings.png new file mode 100644 index 0000000..b25a596 Binary files /dev/null and b/docs/assets/images/app/home_settings.png differ diff --git a/docs/assets/images/app/initial.png b/docs/assets/images/app/initial.png index bfa4c04..851e83a 100644 Binary files a/docs/assets/images/app/initial.png and b/docs/assets/images/app/initial.png differ diff --git a/docs/assets/images/app/search_1.png b/docs/assets/images/app/search_1.png index ea2926c..d24d7d9 100644 Binary files a/docs/assets/images/app/search_1.png and b/docs/assets/images/app/search_1.png differ diff --git a/docs/assets/images/app/search_2.png b/docs/assets/images/app/search_2.png index c7465e2..61479ab 100644 Binary files a/docs/assets/images/app/search_2.png and b/docs/assets/images/app/search_2.png differ diff --git a/docs/assets/images/app/settings.jpg b/docs/assets/images/app/settings.jpg deleted file mode 100644 index c93fd9c..0000000 Binary files a/docs/assets/images/app/settings.jpg and /dev/null differ diff --git a/docs/assets/images/app/settings.png b/docs/assets/images/app/settings.png new file mode 100644 index 0000000..60fb110 Binary files /dev/null and b/docs/assets/images/app/settings.png differ diff --git a/docs/assets/images/app/unauthorized.jpg b/docs/assets/images/app/unauthorized.jpg deleted file mode 100644 index 66eb999..0000000 Binary files a/docs/assets/images/app/unauthorized.jpg and /dev/null differ diff --git a/docs/assets/images/app/unauthorized.png b/docs/assets/images/app/unauthorized.png new file mode 100644 index 0000000..5e854c8 Binary files /dev/null and b/docs/assets/images/app/unauthorized.png differ diff --git a/docs/assets/images/appgallery/screen_1.png b/docs/assets/images/appgallery/screen_1.png index 5c06227..56f438b 100644 Binary files a/docs/assets/images/appgallery/screen_1.png and b/docs/assets/images/appgallery/screen_1.png differ diff --git a/docs/assets/images/appgallery/screen_15.png b/docs/assets/images/appgallery/screen_15.png new file mode 100644 index 0000000..9c7f039 Binary files /dev/null and b/docs/assets/images/appgallery/screen_15.png differ