Add documentation overview of inventory #2538
Conversation
benjaminwil
force-pushed
the
overview_inventory_documentation
branch
from
359bd50
to
a189e98
Compare
guides/inventory/overview.md
Outdated
| - `Spree::StockLocation`: Represents a location where stock items are shipped | ||
| from. Each stock location has `Spree::StockItem`s for each variant in the | ||
| store. | ||
| - `Spree::StockMovement`: Represents stock being added or removed from your |
There was a problem hiding this comment.
or moved from a stock location into another?
guides/inventory/overview.md
Outdated
|
|
||
| [solidus-stock-transfers]: https://github.com/solidusio-contrib/solidus_stock_transfers | ||
|
|
||
| ### Return authorizations |
There was a problem hiding this comment.
It's not immediately clear (at least to me) how this section is related with stock management. I'm not saying it's not related but I think we should specify how here.
We should probably say that the return authorization is something that allows to create ReturnItems. Each ReturnItem in associated with an inventory unit that can be restocked when order items are received back. You can follow the code here to see what happens.
Do you think it could make sense to add these information?
There was a problem hiding this comment.
Thank you. This prompted me to restructure the documentation around returns. All of the RMA-related documentation I wrote now lives in it's own returns/ section, and I've added a stub specifically about Spree::ReturnItems to the inventory overview.
There is definitely more to say about RMAs, ReturnItems and other aspects of the returns system. That will have to be added in future PRs.
benjaminwil
force-pushed
the
overview_inventory_documentation
branch
2 times, most recently
from
87175db
to
dabd150
Compare
Adds an article that functions as an overview of Solidus's inventory system. It has links to other articles that will be committed in other pull requests. For now, these links are commented out.
Adds an article that functions as an overview of Solidus's inventory system. It has links to other articles that will be committed in other pull requests. For now, these links are commented out.
This is part a larger project to improve Solidus's documentation. See this gist with the high-level table of contents. Where and how this documentation will exist is still up for discussion.