doc: update README for improved clarity and formatting#36
Open
SymonMuchemi wants to merge 1 commit into
Open
Conversation
- Removed unnecessary line breaks for better readability. - Standardized warning and note formatting for consistency. - Enhanced feature list presentation by aligning bullet points. - Clarified instructions regarding the use of the URY branch `v1` for accessing previous app versions. - Improved overall structure and flow of the README content to facilitate easier navigation and understanding.
SymonMuchemi
commented
Oct 24, 2025
| - Modern, fast UI with guided flow | ||
| - Shift opening, closing, and cash reconciliation built-in | ||
| - Automatic default customer selection when a POS is loaded | ||
| - New setting to mandate printing an invoice prior to accepting payment |
SymonMuchemi
commented
Oct 24, 2025
| - Advanced filters for order and bill management | ||
| - Modern, fast UI with guided flow | ||
| - Shift opening, closing, and cash reconciliation built-in | ||
| - Automatic default customer selection when a POS is loaded |
SymonMuchemi
commented
Oct 24, 2025
| - Shift opening, closing, and cash reconciliation built-in | ||
| - Automatic default customer selection when a POS is loaded | ||
| - New setting to mandate printing an invoice prior to accepting payment | ||
| - Restaurants with multiple branches (one company, many warehouses) can now validate raw material availability per branch correctly. |
SymonMuchemi
commented
Oct 24, 2025
| - Automatic default customer selection when a POS is loaded | ||
| - New setting to mandate printing an invoice prior to accepting payment | ||
| - Restaurants with multiple branches (one company, many warehouses) can now validate raw material availability per branch correctly. | ||
| - Prevents POS from confirming orders when required raw materials are insufficient. |
SymonMuchemi
commented
Oct 24, 2025
| - New setting to mandate printing an invoice prior to accepting payment | ||
| - Restaurants with multiple branches (one company, many warehouses) can now validate raw material availability per branch correctly. | ||
| - Prevents POS from confirming orders when required raw materials are insufficient. | ||
| - Split stock validation: QSR items validate raw materials at order placement via BOM; at submission skip raw-material checks to avoid double-validation, while non-QSR use standard ERPNext checks. |
SymonMuchemi
commented
Oct 24, 2025
| - Restaurants with multiple branches (one company, many warehouses) can now validate raw material availability per branch correctly. | ||
| - Prevents POS from confirming orders when required raw materials are insufficient. | ||
| - Split stock validation: QSR items validate raw materials at order placement via BOM; at submission skip raw-material checks to avoid double-validation, while non-QSR use standard ERPNext checks. | ||
| - Added skip_raw_material_validation on POS Invoice — validates BOM raw materials only when the invoice is Draft, auto-sets the flag after successful validation to avoid duplicate checks, and skips raw-material validation on submission (falls back to normal stock checks), preventing double-blocking while ensuring material sufficiency upfront. |
SymonMuchemi
commented
Oct 24, 2025
| - Prevents POS from confirming orders when required raw materials are insufficient. | ||
| - Split stock validation: QSR items validate raw materials at order placement via BOM; at submission skip raw-material checks to avoid double-validation, while non-QSR use standard ERPNext checks. | ||
| - Added skip_raw_material_validation on POS Invoice — validates BOM raw materials only when the invoice is Draft, auto-sets the flag after successful validation to avoid duplicate checks, and skips raw-material validation on submission (falls back to normal stock checks), preventing double-blocking while ensuring material sufficiency upfront. | ||
| - Improved BOM handling for QSR (make-to-order) items: added get_all_leaf_bom_items() to expand nested BOMs into leaf components; QSR items without a BOM now halt and raise an error; component quantities are aggregated with correct precision to avoid floating‑point drift. |
SymonMuchemi
commented
Oct 24, 2025
| - Split stock validation: QSR items validate raw materials at order placement via BOM; at submission skip raw-material checks to avoid double-validation, while non-QSR use standard ERPNext checks. | ||
| - Added skip_raw_material_validation on POS Invoice — validates BOM raw materials only when the invoice is Draft, auto-sets the flag after successful validation to avoid duplicate checks, and skips raw-material validation on submission (falls back to normal stock checks), preventing double-blocking while ensuring material sufficiency upfront. | ||
| - Improved BOM handling for QSR (make-to-order) items: added get_all_leaf_bom_items() to expand nested BOMs into leaf components; QSR items without a BOM now halt and raise an error; component quantities are aggregated with correct precision to avoid floating‑point drift. | ||
| - Disable the POS close action and update button feedback when summary data is missing to prevent incomplete closures and improve user clarity. |
SymonMuchemi
commented
Oct 24, 2025
| - Added skip_raw_material_validation on POS Invoice — validates BOM raw materials only when the invoice is Draft, auto-sets the flag after successful validation to avoid duplicate checks, and skips raw-material validation on submission (falls back to normal stock checks), preventing double-blocking while ensuring material sufficiency upfront. | ||
| - Improved BOM handling for QSR (make-to-order) items: added get_all_leaf_bom_items() to expand nested BOMs into leaf components; QSR items without a BOM now halt and raise an error; component quantities are aggregated with correct precision to avoid floating‑point drift. | ||
| - Disable the POS close action and update button feedback when summary data is missing to prevent incomplete closures and improve user clarity. | ||
| - Real-time stock availability tracking directly into the POS menu, providing immediate visual feedback to the cashier and enabling the system to hide unavailable items based on configuration. |
SymonMuchemi
commented
Oct 24, 2025
| - Delay, cancellation, and modification tracking | ||
| - Real-time kitchen analytics | ||
| - Seamless flow from order to service across stations | ||
| - Auto-complete work orders, create stock entries, and sync KOTs to Served on POS submission. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdto provide a clearer and more comprehensive overview of the URY system and its features. The changes improve formatting, add new feature descriptions, and clarify legacy app support details to help users better understand the product and its capabilities.Feature Documentation Improvements:
Formatting and Clarity:
General Documentation Updates:
FEATURES.mdfor users seeking more details.