[IMP] stock_valuation_fifo_lot: readme.md

Author: Tisho99

stock_valuation_fifo_lot/README.rst

@@ -28,7 +28,28 @@ Stock Valuation Fifo Lot
 
 |badge1| |badge2| |badge3| |badge4| |badge5|
 
-This module is used to calculate FIFO cost by lot.
+This module is used to apply FIFO cost calculation at the lot or serial level instead of the product level.
+
+Example: Lot-Level Costing
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Purchase:
+
+  - Lot A: 100 units at $10 each.
+  - Lot B: 100 units at $12 each.
+
+- Sale:
+
+  - 50 units from Lot B.
+
+- COGS Calculation:
+
+  - 50 units * $12 = $600 assigned to COGS.
+
+- Ending Inventory:
+
+  - Lot A: 100 units at $10 each.
+  - Lot B: 50 units at $12 each.
 
 .. IMPORTANT::
    This is an alpha version, the data model and design can change at any time without warning.
@@ -40,6 +61,11 @@ This module is used to calculate FIFO cost by lot.
 .. contents::
    :local:
 
+Usage
+=====
+
+Process an outgoing move with a lot/serial for a product of FIFO costing method, the costs will be calculated based on the lot/serial.
+
 Bug Tracker
 ===========
 

stock_valuation_fifo_lot/readme/DESCRIPTION.rst

@@ -1 +1,22 @@
-This module is used to calculate FIFO cost by lot.
+This module is used to apply FIFO cost calculation at the lot or serial level instead of the product level.
+
+Example: Lot-Level Costing
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Purchase:
+
+  - Lot A: 100 units at $10 each.
+  - Lot B: 100 units at $12 each.
+
+- Sale:
+
+  - 50 units from Lot B.
+
+- COGS Calculation:
+
+  - 50 units * $12 = $600 assigned to COGS.
+
+- Ending Inventory:
+
+  - Lot A: 100 units at $10 each.
+  - Lot B: 50 units at $12 each.

stock_valuation_fifo_lot/readme/USAGE.rst

@@ -0,0 +1 @@
+Process an outgoing move with a lot/serial for a product of FIFO costing method, the costs will be calculated based on the lot/serial.

stock_valuation_fifo_lot/static/description/index.html

@@ -370,7 +370,29 @@ <h1 class="title">Stock Valuation Fifo Lot</h1>
 !! source digest: sha256:877af52a350ab6a61b6c128c4fbcffe909e4a8274c8ec064390dc9b1c36d9253
 !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -->
 <p><a class="reference external image-reference" href="https://odoo-community.org/page/development-status"><img alt="Alpha" src="https://img.shields.io/badge/maturity-Alpha-red.png" /></a> <a class="reference external image-reference" href="http://www.gnu.org/licenses/agpl-3.0-standalone.html"><img alt="License: AGPL-3" src="https://img.shields.io/badge/licence-AGPL--3-blue.png" /></a> <a class="reference external image-reference" href="https://github.com/OCA/stock-logistics-workflow/tree/15.0/stock_valuation_fifo_lot"><img alt="OCA/stock-logistics-workflow" src="https://img.shields.io/badge/github-OCA%2Fstock--logistics--workflow-lightgray.png?logo=github" /></a> <a class="reference external image-reference" href="https://translation.odoo-community.org/projects/stock-logistics-workflow-15-0/stock-logistics-workflow-15-0-stock_valuation_fifo_lot"><img alt="Translate me on Weblate" src="https://img.shields.io/badge/weblate-Translate%20me-F47D42.png" /></a> <a class="reference external image-reference" href="https://runboat.odoo-community.org/builds?repo=OCA/stock-logistics-workflow&amp;target_branch=15.0"><img alt="Try me on Runboat" src="https://img.shields.io/badge/runboat-Try%20me-875A7B.png" /></a></p>
-<p>This module is used to calculate FIFO cost by lot.</p>
+<p>This module is used to apply FIFO cost calculation at the lot or serial level instead of the product level.</p>
+<div class="section" id="example-lot-level-costing">
+<h1>Example: Lot-Level Costing</h1>
+<ul class="simple">
+<li>Purchase:<ul>
+<li>Lot A: 100 units at $10 each.</li>
+<li>Lot B: 100 units at $12 each.</li>
+</ul>
+</li>
+<li>Sale:<ul>
+<li>50 units from Lot B.</li>
+</ul>
+</li>
+<li>COGS Calculation:<ul>
+<li>50 units * $12 = $600 assigned to COGS.</li>
+</ul>
+</li>
+<li>Ending Inventory:<ul>
+<li>Lot A: 100 units at $10 each.</li>
+<li>Lot B: 50 units at $12 each.</li>
+</ul>
+</li>
+</ul>
 <div class="admonition important">
 <p class="first admonition-title">Important</p>
 <p class="last">This is an alpha version, the data model and design can change at any time without warning.
@@ -380,33 +402,35 @@ <h1 class="title">Stock Valuation Fifo Lot</h1>
 <p><strong>Table of contents</strong></p>
 <div class="contents local topic" id="contents">
 <ul class="simple">
-<li><a class="reference internal" href="#bug-tracker" id="toc-entry-1">Bug Tracker</a></li>
-<li><a class="reference internal" href="#credits" id="toc-entry-2">Credits</a><ul>
-<li><a class="reference internal" href="#authors" id="toc-entry-3">Authors</a></li>
-<li><a class="reference internal" href="#contributors" id="toc-entry-4">Contributors</a></li>
-<li><a class="reference internal" href="#maintainers" id="toc-entry-5">Maintainers</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#usage" id="toc-entry-1">Usage</a></li>
+<li><a class="reference internal" href="#bug-tracker" id="toc-entry-2">Bug Tracker</a></li>
+<li><a class="reference internal" href="#credits" id="toc-entry-3">Credits</a></li>
 </ul>
 </div>
+<div class="section" id="usage">
+<h2><a class="toc-backref" href="#toc-entry-1">Usage</a></h2>
+<p>Process an outgoing move with a lot/serial for a product of FIFO costing method, the costs will be calculated based on the lot/serial.</p>
+</div>
 <div class="section" id="bug-tracker">
-<h1><a class="toc-backref" href="#toc-entry-1">Bug Tracker</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-2">Bug Tracker</a></h2>
 <p>Bugs are tracked on <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/issues">GitHub Issues</a>.
 In case of trouble, please check there if your issue has already been reported.
 If you spotted it first, help us to smash it by providing a detailed and welcomed
 <a class="reference external" href="https://github.com/OCA/stock-logistics-workflow/issues/new?body=module:%20stock_valuation_fifo_lot%0Aversion:%2015.0%0A%0A**Steps%20to%20reproduce**%0A-%20...%0A%0A**Current%20behavior**%0A%0A**Expected%20behavior**">feedback</a>.</p>
 <p>Do not contact contributors directly about support or help with technical issues.</p>
 </div>
 <div class="section" id="credits">
-<h1><a class="toc-backref" href="#toc-entry-2">Credits</a></h1>
+<h2><a class="toc-backref" href="#toc-entry-3">Credits</a></h2>
+</div>
+</div>
 <div class="section" id="authors">
-<h2><a class="toc-backref" href="#toc-entry-3">Authors</a></h2>
+<h1>Authors</h1>
 <ul class="simple">
 <li>Ecosoft</li>
 </ul>
 </div>
 <div class="section" id="contributors">
-<h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
+<h1>Contributors</h1>
 <ul class="simple">
 <li><a class="reference external" href="http://ecosoft.co.th">Ecosoft</a>:<ul>
 <li>Tharathip Chaweewongphan &lt;<a class="reference external" href="mailto:tharathipc&#64;ecosoft.co.th">tharathipc&#64;ecosoft.co.th</a>&gt;</li>
@@ -417,7 +441,7 @@ <h2><a class="toc-backref" href="#toc-entry-4">Contributors</a></h2>
 </ul>
 </div>
 <div class="section" id="maintainers">
-<h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
+<h1>Maintainers</h1>
 <p>This module is maintained by the OCA.</p>
 <a class="reference external image-reference" href="https://odoo-community.org">
 <img alt="Odoo Community Association" src="https://odoo-community.org/logo.png" />
@@ -431,6 +455,5 @@ <h2><a class="toc-backref" href="#toc-entry-5">Maintainers</a></h2>
 <p>You are welcome to contribute. To learn how please visit <a class="reference external" href="https://odoo-community.org/page/Contribute">https://odoo-community.org/page/Contribute</a>.</p>
 </div>
 </div>
-</div>
 </body>
 </html>