Skip to content

Commit 97c3d3b

Browse files
committed
docs: clarify exporter maturity and lint fixtures
1 parent d7b1aeb commit 97c3d3b

3 files changed

Lines changed: 57 additions & 0 deletions

File tree

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,27 @@ Generated examples live under:
111111

112112
- [docs/demos](./docs/demos)
113113

114+
## Exporter Maturity
115+
116+
To avoid false expectations, exporters are grouped by maturity level.
117+
118+
Stable:
119+
120+
- `json`
121+
- `context`
122+
- `markdown`
123+
- `html`
124+
- `graph`
125+
126+
Experimental / scaffold:
127+
128+
- `contract`
129+
- `bpmn`
130+
- `plantuml`
131+
- `littlehorse`
132+
133+
Experimental exporters are intended as skeletons or integration scaffolds and may require manual review.
134+
114135
## Hero Demo: Craft Business Lead to Order
115136

116137
The main showcase flow is:
@@ -238,6 +259,8 @@ npm run check:all
238259
npm run demo:generate
239260
```
240261

262+
Note: files under `tests/lint/` are intentionally invalid and are used to verify lint findings. Running `orgscript lint` on those fixtures is expected to fail.
263+
241264
## Ecosystem
242265

243266
- VS Code extension: [editors/vscode](./editors/vscode)

docs/OrgScript-Handbuch-DE.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,23 @@ Standardverhalten der Exporter:
178178

179179
So bleibt Geschaeftslogik explizit und Kommentare werden keine versteckte zweite Sprache.
180180

181+
## Exporter-Reifegrade
182+
183+
Stabil:
184+
185+
- `json`
186+
- `context`
187+
- `markdown`
188+
- `html`
189+
- `graph`
190+
191+
Experimentell / Scaffold:
192+
193+
- `contract`
194+
- `bpmn`
195+
- `plantuml`
196+
- `littlehorse`
197+
181198
## Schreibregeln
182199

183200
- eine Anweisung pro Zeile

docs/OrgScript-Manual-EN.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,23 @@ Default exporter policy:
178178

179179
This keeps business meaning explicit and prevents comments from becoming a hidden second language.
180180

181+
## Exporter maturity
182+
183+
Stable:
184+
185+
- `json`
186+
- `context`
187+
- `markdown`
188+
- `html`
189+
- `graph`
190+
191+
Experimental / scaffold:
192+
193+
- `contract`
194+
- `bpmn`
195+
- `plantuml`
196+
- `littlehorse`
197+
181198
## Writing guidelines
182199

183200
- keep one statement per line

0 commit comments

Comments
 (0)