eigen/trackgo-fe
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 12 Wiki Activity

docs: update sales workflow and Core App Shell documentation for clarity

Browse Source 
- 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.
This commit is contained in:
shancheas
2026-08-31 14:51:16 +07:00
parent c0d08df82b
commit 25f1b79042
2 changed files with 5 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs-dev/src/packages/ui/CORE-APP-SHELL.md
+4 -2
View File
@@ -150,7 +150,8 @@ interface CoreAppShellFeatures {
| `zIndex` | `number` | `200` | Base z-index passed to Mantine's `AppShell`. | | `zIndex` | `number` | `200` | Base z-index passed to Mantine's `AppShell`. |
| `disabled` | `boolean` | `false` | Disables the AppShell layout entirely (renders children without structural chrome). | | `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 | | `toggleNavbarPanel()` | `() => void` | Toggle the double-sidebar panel open/closed |
| `setSidebarVariant()` | `(variant: SidebarVariant) => void` | Programmatically set the sidebar to `'expanded'`, `'mini'`, or `'hidden'` | | `setSidebarVariant()` | `(variant: SidebarVariant) => void` | Programmatically set the sidebar to `'expanded'`, `'mini'`, or `'hidden'` |
> [!WARNING] > `useCoreAppShell()` **must** be called from within a `<CoreAppShell>` 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 `<CoreAppShell>` 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.
--- ---
apps/docs-dev/src/sales-workflow.md
+1 -1
View File
@@ -22,7 +22,7 @@ Packing slip
Processed to completed trigger by action from user Processed to completed trigger by action from user
Cancelled trigger by action from user and cancel sales order Cancelled trigger by action from user and cancel sales order
Sales invoice 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 Partial when invoice is paid partially
Completed when invoice is all paid Completed when invoice is all paid
Sales payment Sales payment