IDSolutions/forge
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Docs #9

Closed
J.Schmidt92 wants to merge 8 commits from master into feature/surrealdb-storage
pull from: master
merge into: IDSolutions:feature/surrealdb-storage
Conversation 0 Commits 8 Files Changed 48 +14
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit 586c3dcde8 - Show all commits

14
docs/MODULE_REFERENCE.md
View File

@ -89,6 +89,8 @@ Nested groups use additional `:` separators, for example
| `actor:delete` | Delete actor data. |
| `actor:hot:init`, `actor:hot:get`, `actor:hot:keys`, `actor:hot:override`, `actor:hot:save`, `actor:hot:remove` | Manage actor hot state. |
See [Actor Usage Guide](./ACTOR_USAGE_GUIDE.md) for examples.
### Bank
| Command | Purpose |
@ -99,6 +101,8 @@ Nested groups use additional `:` separators, for example
| `bank:hot:charge_checkout` | Charge a checkout against hot bank state. |
| `bank:hot:validate_pin` | Validate a PIN for bank operations. |
See [Bank Usage Guide](./BANK_USAGE_GUIDE.md) for examples.
### Garage
| Command | Purpose |
@ -127,6 +131,8 @@ See [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md) for examples.
| `org:members:get`, `org:members:add`, `org:members:remove` | Manage organization membership. |
| `org:hot:*` | Runtime organization workflows including registration, invites, credit lines, checkout charging, assets, fleet, leave, disband, save, and remove. |
See [Org Usage Guide](./ORG_USAGE_GUIDE.md) for examples.
### Phone
| Command | Purpose |
@ -137,6 +143,8 @@ See [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md) for examples.
| `phone:emails:list`, `phone:emails:send`, `phone:emails:mark_read`, `phone:emails:delete` | Manage emails. |
| `phone:remove` | Remove phone state for a UID. |
See [Phone Usage Guide](./PHONE_USAGE_GUIDE.md) for examples.
### CAD
| Command Group | Purpose |
@ -149,6 +157,8 @@ See [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md) for examples.
| `cad:groups:build` | Build grouped CAD state. |
| `cad:view:hydrate` | Build the dispatcher view model. |
See [CAD Usage Guide](./CAD_USAGE_GUIDE.md) for examples.
### Task
| Command Group | Purpose |
@ -160,6 +170,8 @@ See [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md) for examples.
| `task:defuse:increment`, `task:defuse:get` | Manage defuse counters. |
| `task:clear` | Clear task state. |
See [Task Usage Guide](./TASK_USAGE_GUIDE.md) for examples.
### Owned Storage
| Command Group | Purpose |
@ -169,6 +181,8 @@ See [Locker Usage Guide](./LOCKER_USAGE_GUIDE.md) for examples.
| `owned:locker:create`, `owned:locker:fetch`, `owned:locker:get`, `owned:locker:add`, `owned:locker:remove`, `owned:locker:delete`, `owned:locker:exists` | Owner-scoped item storage. |
| `owned:locker:hot:*` | Owner-scoped item hot state. |
See [Owned Storage Usage Guide](./OWNED_STORAGE_USAGE_GUIDE.md) for examples.
### Other Extension Groups
| Command Group | Purpose |