From 25f1b79042ae61fcc2a72252f0e124e73552df31 Mon Sep 17 00:00:00 2001 From: shancheas Date: Mon, 31 Aug 2026 14:51:16 +0700 Subject: [PATCH] docs: update sales workflow and Core App Shell documentation for clarity - Clarified the transition from Draft to Processed in the sales workflow, specifying that it can occur through both invoice addition to the sales plan and manual triggers. - Improved formatting in the Core App Shell documentation by separating tips and warnings into distinct lines for better readability. These changes enhance the documentation's clarity and usability, aiding developers in understanding the workflow and component usage. --- apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md | 6 ++++-- apps/docs-dev/src/sales-workflow.md | 2 +- 2 files changed, 5 insertions(+), 3 deletions(-) diff --git a/apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md b/apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md index 77a3330..43e5c94 100644 --- a/apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md +++ b/apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md @@ -150,7 +150,8 @@ interface CoreAppShellFeatures { | `zIndex` | `number` | `200` | Base z-index passed to Mantine's `AppShell`. | | `disabled` | `boolean` | `false` | Disables the AppShell layout entirely (renders children without structural chrome). | -> [!TIP] > **Smart defaults**: You rarely need to set `withUtilityBar`, `withAside`, or `withFooter` explicitly. The engine auto-detects presence by checking if the corresponding slot is provided and truthy. Only set them to `false` when you want to **suppress** a slot that is being passed. +> [!TIP] +> **Smart defaults**: You rarely need to set `withUtilityBar`, `withAside`, or `withFooter` explicitly. The engine auto-detects presence by checking if the corresponding slot is provided and truthy. Only set them to `false` when you want to **suppress** a slot that is being passed. --- @@ -233,7 +234,8 @@ import { useCoreAppShell } from '@repo/ui/components'; | `toggleNavbarPanel()` | `() => void` | Toggle the double-sidebar panel open/closed | | `setSidebarVariant()` | `(variant: SidebarVariant) => void` | Programmatically set the sidebar to `'expanded'`, `'mini'`, or `'hidden'` | -> [!WARNING] > `useCoreAppShell()` **must** be called from within a `` subtree. Calling it outside the provider will throw: `"useCoreAppShell must be used within CoreAppShellProvider"`. If you need context access in the header slot, pass a component (not inline JSX) so it mounts inside the provider tree. +> [!WARNING] +> `useCoreAppShell()` **must** be called from within a `` subtree. Calling it outside the provider will throw: `"useCoreAppShell must be used within CoreAppShellProvider"`. If you need context access in the header slot, pass a component (not inline JSX) so it mounts inside the provider tree. --- diff --git a/apps/docs-dev/src/sales-workflow.md b/apps/docs-dev/src/sales-workflow.md index b775848..235aac9 100644 --- a/apps/docs-dev/src/sales-workflow.md +++ b/apps/docs-dev/src/sales-workflow.md @@ -22,7 +22,7 @@ Packing slip Processed to completed trigger by action from user Cancelled trigger by action from user and cancel sales order Sales invoice -Draft to Processed when invoice is add to sales plan +Draft to Processed when invoice is add to sales plan or manual trigger draft to processed Partial when invoice is paid partially Completed when invoice is all paid Sales payment