inventree/InvenTree
2
0
Fork 0
mirror of https://github.com/inventree/InvenTree.git synced 2025-08-13 15:20:53 +00:00
Code Activity

Docs refactor (#9545)

Browse Source 
* 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
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/docs/settings/error_codes.md
View File

@@ -69,7 +69,7 @@ See [INVE-W1](#inve-w1)
InvenTree is running in debug mode. This is **not** recommended for production use, as it exposes sensitive information and makes the server more vulnerable to attacks. Debug mode is not intended for production/exposed instances, **even for short duration**.
It is recommended to run InvenTree in production mode for better security and performance. See [Debug Mode Information](../start/intro.md#debug-mode).
It is recommended to run InvenTree in production mode for better security and performance. See [Debug Mode Information](../start/index.md#debug-mode).
#### INVE-W5
**Background worker process not running - Backend**

2
docs/docs/settings/experimental.md
View File

@@ -14,4 +14,4 @@ Superusers can configure run-time conditions [as per django-flags](https://cfpb.
| Feature | Key | Description |
| ------- | ----------- |
| oAuth provider / api | OIDC | Use oAuth and OIDC to authenticate users with the API - [read more](../api/api.md#oauth2--oidc). |
| oAuth provider / api | OIDC | Use oAuth and OIDC to authenticate users with the API - [read more](../api/index.md#oauth2--oidc). |

13
docs/docs/settings/global.md
View File

@@ -91,7 +91,7 @@ Configuration of barcode functionality:
{{ globalsetting("BARCODE_STORE_RESULTS") }}
{{ globalsetting("BARCODE_RESULTS_MAX_NUM") }}
Read more about [barcode scanning](../barcodes/barcodes.md).
Read more about [barcode scanning](../barcodes/index.md).
### Pricing and Currency
@@ -157,6 +157,7 @@ Configuration of report generation:
{{ globalsetting("PART_COPY_TESTS") }}
{{ globalsetting("PART_CATEGORY_PARAMETERS") }}
{{ globalsetting("PART_CATEGORY_DEFAULT_ICON") }}
{{ globalsetting("PART_PARAMETER_ENFORCE_UNITS") }}
#### Part Parameter Templates
@@ -169,7 +170,7 @@ In this section of the settings, staff users can set a list of parameters associ
To add a parameter to a part category:
1. select the category in the dropdown list
2. click the <span class="badge inventree add"><span class='fas fa-plus-circle'></span> New Parameter</span> button on the top right
2. click the <span class="badge inventree add">{{ icon("plus-circle") }} New Parameter</span> button on the top right
3. fill out the "Create Category Parameter Template" form
4. click the <span class="badge inventree confirm">Submit</span> button.
@@ -199,19 +200,19 @@ Configuration of stock item options
### Build Orders
Refer to the [build order settings](../build/build.md#build-order-settings).
Refer to the [build order settings](../manufacturing/build.md#build-order-settings).
### Purchase Orders
Refer to the [purchase order settings](../order/purchase_order.md#purchase-order-settings).
Refer to the [purchase order settings](../purchasing/purchase_order.md#purchase-order-settings).
### Sales Orders
Refer to the [sales order settings](../order/sales_order.md#sales-order-settings).
Refer to the [sales order settings](../sales/sales_order.md#sales-order-settings).
### Return Orders
Refer to the [return order settings](../order/return_order.md#return-order-settings).
Refer to the [return order settings](../sales/return_order.md#return-order-settings).
### Plugin Settings

2
docs/docs/settings/reference.md
View File

@@ -4,7 +4,7 @@ title: Reference Patterns
## Reference Patterns
InvenTree contains a number of data models which require a *unique* reference field (such as [Purchase Orders](../order/purchase_order.md)). In addition to being *unique* these reference values must conform to a specific *pattern* (which can be defined by the user). Defined reference patterns also make it simple for the user to control how references are generated.
InvenTree contains a number of data models which require a *unique* reference field (such as [Purchase Orders](../purchasing/purchase_order.md)). In addition to being *unique* these reference values must conform to a specific *pattern* (which can be defined by the user). Defined reference patterns also make it simple for the user to control how references are generated.
### Default Patterns