Skip to content

Commit 40ed88e

Browse files
committed
docs(examples): curate example tiers and navigation
1 parent edafe72 commit 40ed88e

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

examples/README.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,43 @@
11
# OrgScript Examples
22

3-
This folder shows OrgScript at three adoption levels.
3+
This folder is the quickest way to learn OrgScript by reading real files.
4+
5+
## Suggested path
6+
7+
1. Start with `simple` if you want the smallest readable process example.
8+
2. Move to `realistic` when you want end-to-end business flows.
9+
3. Use `advanced` when you want mixed block types and exporter coverage.
410

511
## Simple
612

713
- [`lead-qualification.orgs`](lead-qualification.orgs)
8-
A compact process example focused on trigger, branching, assignment, and transition.
14+
Best first read. A compact process example focused on trigger, branching, assignment, and transition.
915

1016
## Realistic
1117

1218
- [`craft-business-lead-to-order.orgs`](craft-business-lead-to-order.orgs)
1319
A fuller business flow from lead intake through qualification, quote conversion, and order lifecycle.
1420
- [`service-escalation.orgs`](service-escalation.orgs)
15-
A policy- and event-oriented example for support and response handling.
21+
A policy- and event-oriented example for support handling, escalation, and role-based action.
1622

1723
## Advanced
1824

1925
- [`order-approval.orgs`](order-approval.orgs)
2026
A mixed file showing stateflow and rule modeling together, useful for exports and downstream tooling.
2127

28+
## Quick index
29+
30+
- `lead-qualification.orgs` - smallest onboarding example
31+
- `craft-business-lead-to-order.orgs` - craft-business pipeline and qualification logic
32+
- `service-escalation.orgs` - support escalation, policy flow, and permissions
33+
- `order-approval.orgs` - stateflow plus rule modeling in one file
34+
2235
## How to use the examples
2336

24-
- Start with the `Simple` example if you are learning the language.
25-
- Move to `Realistic` once you want to model operational flows end to end.
26-
- Use `Advanced` when testing exports, linting, or tooling assumptions across multiple block types.
37+
- Read `lead-qualification.orgs` first to learn the smallest useful pattern.
38+
- Read `craft-business-lead-to-order.orgs` next to see a fuller real-world process.
39+
- Read `service-escalation.orgs` to see policy and role behavior.
40+
- Read `order-approval.orgs` when you want to see stateflow and rule modeling together.
2741

2842
## Suggested commands
2943

0 commit comments

Comments
 (0)