inventree/inventree-docs
2
0
Fork 0
mirror of https://github.com/inventree/inventree-docs.git synced 2025-04-27 21:26:43 +00:00
Code

Add details on mobile app

Browse Source
This commit is contained in:
Oliver Walters 2021-02-21 21:47:05 +11:00
parent 2c62069ac0
commit c133174029
11 changed files with 173 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
docs/app/app.md
View File

@ -4,5 +4,43 @@ title: InvenTree Mobile App
## InvenTree Mobile App
!!! note "Work In Progress"
InvenTree app documentation will be available soon.
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

31
docs/app/barcode.md Normal file
View File

@ -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

13
docs/app/issues.md Normal file
View File

@ -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!

38
docs/app/part.md Normal file
View File

@ -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

22
docs/app/stock.md Normal file
View File

@ -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

17
docs/app/translation.md Normal file
View File

@ -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!

2
docs/releases/0.1.4.md
View File

@ -1,5 +1,5 @@
---
title: v0.1.4
title: Release 0.1.4
---
## Release 0.1.4

2
docs/releases/0.1.5.md
View File

@ -1,5 +1,5 @@
---
title: v0.1.5
title: Release 0.1.5
---
## Release 0.1.5

4
docs/releases/0.1.6.md
View File

@ -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.5](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

3
docs/releases/new.md
View File

@ -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 |

7
mkdocs.yml
View File

@ -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: