Docs refactor (#9545)

* Refactor / reognaize docs structure

* Refactor plugin docs structure

* More refactoring / cleanup

* Update build images

* Gallery updates

* Order images

* Update part docs

* Settings images

* Stock images

* Reitntroduce gallery

* Add custom icon macro

* Update icons

* Cleanup

* Fix link

* Fix internal links

* Revert some page moves

* Fix links

* Fix links
This commit is contained in:
Oliver
2025-04-22 08:18:32 +10:00
committed by GitHub
parent 9b489911e5
commit 6b08e45eac
240 changed files with 964 additions and 831 deletions
+2 -2
View File
@@ -6,7 +6,7 @@ title: Custom Barcodes
With the provision of [internal](./internal.md) and [external](./external.md) barcode support, a lot of potential use-cases are already supported directly by InvenTree.
However, if further customization is required, or a bespoke barcode workflow which is not supported already, then this can easily be implemented using the [plugin system](../extend/plugins/barcode.md).
However, if further customization is required, or a bespoke barcode workflow which is not supported already, then this can easily be implemented using the [plugin system](../plugins/mixins/barcode.md).
A custom barcode plugin can be used to (for example) perform a particular action when a barcode is scanned.
@@ -22,7 +22,7 @@ The barcode is tested as follows, in decreasing order of priority:
- [Internal Barcode Plugin](./internal.md)
- [External Barcode Plugin](./external.md)
- [Custom Barcode Plugins](../extend/plugins/barcode.md)
- [Custom Barcode Plugins](../plugins/mixins/barcode.md)
!!! tip "Plugin Loading Order"
The first custom plugin to return a result "wins". As the loading order of custom plugins is not defined (or configurable), take special care if you are running multiple plugins which support barcode actions.
+2 -2
View File
@@ -6,7 +6,7 @@ title: External Barcodes
In addition to defining an [internal barcode format](./internal.md), models which have associated barcode information also allow arbitrary external (third party) barcodes to be assigned or "linked" to items in the database.
For example, you have just purchased a reel of capacitors from a supplier, which comes provided with a sufficiently unique barcode or qr-code. Instead of printing an *internal* barcode, the existing barcode can be scanned and *linked* to the specific reel (which is a [Stock Item](../stock/stock.md#stock-item)).
For example, you have just purchased a reel of capacitors from a supplier, which comes provided with a sufficiently unique barcode or qr-code. Instead of printing an *internal* barcode, the existing barcode can be scanned and *linked* to the specific reel (which is a [Stock Item](../stock/index.md#stock-item)).
Linking to external barcodes allows an alternative barcode workflow, which may be especially useful when dealing with in-feed components which are received from external suppliers.
@@ -17,7 +17,7 @@ Linking to external barcodes allows an alternative barcode workflow, which may b
### Via the API
Facility for barcode linking (and un-linking) is provided via the [API](../api/api.md).
Facility for barcode linking (and un-linking) is provided via the [API](../api/index.md).
- The `/api/barcode/link/` API endpoint is used to link a barcode with an existing database item
- The `/api/barcode/unlink/` API endpoint is used to unlink a barcode from an existing database item
@@ -6,12 +6,12 @@ title: Barcodes
InvenTree has native support for barcodes, which provides powerful functionality "out of the box", and can be easily extended:
- Barcodes can be scanned [via the API](../api/api.md)
- Barcodes can be scanned [via the API](../api/index.md)
- The web interface supports barcode scanning
- Barcodes integrate natively [with the mobile app](../app/barcode.md)
- Custom barcodes can be assigned to items
- Barcodes can be embedded in [labels or reports](../report/barcodes.md)
- Barcode functionality can be [extended via plugins](../extend/plugins/barcode.md)
- Barcode functionality can be [extended via plugins](../plugins/mixins/barcode.md)
### Barcode Formats
@@ -25,14 +25,14 @@ InvenTree supports the following barcode formats:
Barcodes can be linked with the following data model types:
- [Part](../part/part.md#part)
- [Stock Item](../stock/stock.md#stock-item)
- [Stock Location](../stock/stock.md#stock-location)
- [Supplier Part](../order/company.md#supplier-parts)
- [Purchase Order](../order/purchase_order.md#purchase-orders)
- [Sales Order](../order/sales_order.md#sales-orders)
- [Return Order](../order/return_order.md#return-orders)
- [Build Order](../build/build.md#build-orders)
- [Part](../part/index.md#part)
- [Stock Item](../stock/index.md#stock-item)
- [Stock Location](../stock/index.md#stock-location)
- [Supplier Part](../purchasing/supplier.md#supplier-parts)
- [Purchase Order](../purchasing/purchase_order.md#purchase-orders)
- [Sales Order](../sales/sales_order.md#sales-orders)
- [Return Order](../sales/return_order.md#return-orders)
- [Build Order](../manufacturing/build.md#build-orders)
### Configuration Options