diff --git a/docs/app/app.md b/docs/app/app.md index c5013f4..90f7f4c 100644 --- a/docs/app/app.md +++ b/docs/app/app.md @@ -4,5 +4,43 @@ title: InvenTree Mobile App ## InvenTree Mobile App -!!! note "Work In Progress" - InvenTree app documentation will be available soon. \ No newline at end of file +The InvenTree Mobile App brings stock control to your pocket. Integrating seamlessly with the [InvenTree API](../../extend/api), the app provides immediate access to inventory data without requiring physical access to a computer. + +Native barcode support provides a multitude of context-sensitive stock control actions, allowing streamlined inventory management at your fingertips. + +## Download + +### Android + +The InvenTree App can be downloaded for Android devices via the [Play Store](https://play.google.com/store/apps/details?id=inventree.inventree_app). + +### iOS + +!!! missing "Not Yet Available" + The InvenTree app is not yet available for iOS devices + +## Connect to InvenTree + +Use of the InvenTree app assumes that you (the user) have access to an InvenTree server. + +!!! success "Profiles" + The app supports multiple user profiles, providing simple switching between different InvenTree servers and/or account profiles. + +!!! todo "Add Screenshot" + Add screenshot of "Profiles" screen + +!!! todo "Add Screenshot" + Add screenshot of "connection failed" screen + +!!! todo "Add Screenshot" + Add screenshow of "connection success" screen + +## Index Page + +!!! todo "TODO" + This section requires further work + +## Menu Bar + +!!! todo "TODO" + This section requires further work diff --git a/docs/app/barcode.md b/docs/app/barcode.md new file mode 100644 index 0000000..d6996c2 --- /dev/null +++ b/docs/app/barcode.md @@ -0,0 +1,31 @@ +--- +title: App Barcode Support +--- + +## Barcode Support + +One of the key elements of functionality provided by the InvenTree app is the native support for context-sensitive barcode scanning. + +Barcode integration allows extremely efficient stock control, for information lookup and also performing various actions. + +### Supported Codes + +The following code types are known to be supported + +**1D Codes** + +- Code-39 +- Code-93 +- Code-128 +- ITF + +**2D Codes** + +- QR Code +- Data Matrix +- Aztec + +## Actions + +!!! todo "TODO" + This section requires further work \ No newline at end of file diff --git a/docs/app/issues.md b/docs/app/issues.md new file mode 100644 index 0000000..e50fbf3 --- /dev/null +++ b/docs/app/issues.md @@ -0,0 +1,13 @@ +--- +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) + +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/part.md b/docs/app/part.md new file mode 100644 index 0000000..67a7c67 --- /dev/null +++ b/docs/app/part.md @@ -0,0 +1,38 @@ +--- +title: Part Views +--- + +## InvenTree App Part Views + +!!! todo "TODO" + This section requires further work + +## Part + +!!! todo "TODO" + This section requires further work + +### Details + +!!! todo "TODO" + This section requires further work + +### Stock + +!!! todo "TODO" + This section requires further work + +## Part Category + +!!! todo "TODO" + This section requires further work + +### Details + +!!! todo "TODO" + This section requires further work + +### Parts + +!!! todo "TODO" + This section requires further work \ No newline at end of file diff --git a/docs/app/stock.md b/docs/app/stock.md new file mode 100644 index 0000000..d49f7a9 --- /dev/null +++ b/docs/app/stock.md @@ -0,0 +1,22 @@ +--- +title: Stock Views +--- + +## InvenTree App Stock Views + +!!! todo "TODO" + This section requires further work + +## Stock Item + +### Details + +### Actions + +## Stock Location + +### Details + +### Actions + +## Search \ No newline at end of file diff --git a/docs/app/translation.md b/docs/app/translation.md new file mode 100644 index 0000000..8b8c628 --- /dev/null +++ b/docs/app/translation.md @@ -0,0 +1,17 @@ +--- +title: App Translations +--- + +## Translation Support + +The InvenTree app, much like the InvenTree web-based application, is designed to support multiple language translations. + +As with the web application, translations are community contributed - if the app does not support your native language, contributions are very welcome! + +## Contributing + +Translation files for the InvenTree app are [available on GitHub](https://github.com/inventree/inventree-app-i18n/). + +A Python helper script simplifies the translation process by presenting the user with words or phrases which require translation, one item at a time. + +Full translation efforts, while appreciated, are not required. Please feel free to contribute as much as you can! \ No newline at end of file diff --git a/docs/releases/0.1.4.md b/docs/releases/0.1.4.md index 6ab4105..cb8237d 100644 --- a/docs/releases/0.1.4.md +++ b/docs/releases/0.1.4.md @@ -1,5 +1,5 @@ --- -title: v0.1.4 +title: Release 0.1.4 --- ## Release 0.1.4 diff --git a/docs/releases/0.1.5.md b/docs/releases/0.1.5.md index f6afc7a..dfede93 100644 --- a/docs/releases/0.1.5.md +++ b/docs/releases/0.1.5.md @@ -1,5 +1,5 @@ --- -title: v0.1.5 +title: Release 0.1.5 --- ## Release 0.1.5 diff --git a/docs/releases/0.1.6.md b/docs/releases/0.1.6.md index 09b49c5..85f95b1 100644 --- a/docs/releases/0.1.6.md +++ b/docs/releases/0.1.6.md @@ -1,10 +1,10 @@ --- -title: v0.1.5 +title: Release 0.1.6 --- ## Release 0.1.6 -[Release 0.1.5](https://github.com/inventree/InvenTree/releases/tag/0.1.5) (Febuary 2021) provides a number of major new features and improvements, as well as some crucial bug fixes: +[Release 0.1.6](https://github.com/inventree/InvenTree/releases/tag/0.1.6) (Febuary 2021) provides a number of major new features and improvements, as well as some crucial bug fixes: ## New Features diff --git a/docs/releases/new.md b/docs/releases/new.md index c4bd0c2..d64d88a 100644 --- a/docs/releases/new.md +++ b/docs/releases/new.md @@ -8,7 +8,8 @@ For information on the latest and greatest InvenTree features, refer to the rele | Release | Date | | ------- | ---- | -| 0.1.6 | *In Development* | +| 0.1.7 | *In Development* | +| [0.1.6](../0.1.6) | February 2021 | | [0.1.5](../0.1.5) | January 2021 | | [0.1.4](../0.1.4) | November 2020 | diff --git a/mkdocs.yml b/mkdocs.yml index 4681587..b7677cb 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -91,8 +91,13 @@ nav: - Themes: extend/themes.md - Third-Party: extend/integrate.md - App: - - App: app/app.md + - InvenTree App: app/app.md + - Barcodes: app/barcode.md + - Parts: app/part.md + - Stock: app/barcode.md - Privacy: app/privacy.md + - Translation: app/translation.md + - Suggestions: app/issues.md # Plugins plugins: