update
This commit is contained in:
parent
7f32f2429e
commit
65bfb5f8e2
10 changed files with 60 additions and 55 deletions
5
docs/Flow.md
Normal file
5
docs/Flow.md
Normal file
|
@ -0,0 +1,5 @@
|
|||
# Flow
|
||||
A flow is used to represent a workflow or manufacturing process.
|
||||
|
||||
## Flow Info
|
||||
You define a flow within a JSON file stored in `./flows`.
|
|
@ -64,4 +64,3 @@ variants:
|
|||
```
|
||||
|
||||
This will mark any item variant as expired if it's older than 30 days.
|
||||
|
||||
|
|
|
@ -1,7 +1,13 @@
|
|||
# CDB Documentation
|
||||
|
||||
- Item
|
||||
- Location
|
||||
- Statistics
|
||||
- Transaction
|
||||
- Webhooks
|
||||
## Basic Concepts
|
||||
- [Item](./Item.md)
|
||||
- [Transaction](./Transaction.md)
|
||||
- [Location](./Location.md)
|
||||
|
||||
## Pipelines
|
||||
- [Flow](./Flow.md)
|
||||
|
||||
## Advanced
|
||||
- [Statistics](./Statistics.md)
|
||||
- [Webhooks](./Webhooks.md)
|
||||
|
|
|
@ -8,10 +8,11 @@ Transactions can carry some information:
|
|||
- Price - The price this item was acquired at
|
||||
- Origin - Where this item is from
|
||||
- Location - The [Location](Location.md) of the item
|
||||
- Note - General notes
|
||||
|
||||
## Consume
|
||||
If an item gets used or is removed from the inventory, you consume the transaction.
|
||||
|
||||
This adds some additional information to it:
|
||||
- Price - The price of the item at removal. e.g the selling price, or if negative cost of removal
|
||||
- Price - The price of the item at removal. e.g a selling price, or a negative value can represent cost of removal
|
||||
- Destination - Where this item went, e.g a person who requested this item
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue