Skip to content

Commit 9e23723

Browse files
committed
Update website to new action syntax (no brackets)
1 parent 9a4cdfb commit 9e23723

18 files changed

+61
-61
lines changed

Website/src/disclaimer.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ <h3><span class="section-icon">&#x1F512;</span> The Power of Constraints</h3>
342342
<div class="motivation-section accent-cyan animate-on-scroll">
343343
<h3><span class="section-icon">&#x1F4D6;</span> Code That Reads Like Documentation</h3>
344344
<p>
345-
ARO's fixed grammar—<code>&lt;Action&gt; the &lt;Result&gt; preposition the &lt;Object&gt;</code>—means
345+
ARO's fixed grammar—<code>Action the &lt;Result&gt; preposition the &lt;Object&gt;</code>—means
346346
every statement follows the same structure. There's no style guide debate. The grammar <em>is</em>
347347
the style guide.
348348
</p>

Website/src/docs/actions.html

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -102,9 +102,9 @@ <h3>Retrieve</h3>
102102

103103
<h3>Request</h3>
104104
<p>Make HTTP requests to external APIs:</p>
105-
<pre><code><span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;data&gt;</span> from <span class="code-string">"https://api.example.com/resource"</span>.
106-
<span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;users&gt;</span> from &lt;UserAPI: GET /users&gt;.
107-
<span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;weather&gt;</span> from &lt;WeatherAPI: GET /forecast?city=${city}&gt;.</code></pre>
105+
<pre><code><span class="code-keyword">Request</span> the <span class="code-result">&lt;data&gt;</span> from <span class="code-string">"https://api.example.com/resource"</span>.
106+
<span class="code-keyword">Request</span> the <span class="code-result">&lt;users&gt;</span> from &lt;UserAPI: GET /users&gt;.
107+
<span class="code-keyword">Request</span> the <span class="code-result">&lt;weather&gt;</span> from &lt;WeatherAPI: GET /forecast?city=${city}&gt;.</code></pre>
108108

109109
<h3>Read</h3>
110110
<p>Read from files:</p>
@@ -115,18 +115,18 @@ <h3>Read</h3>
115115
<h3>Request</h3>
116116
<p>Make HTTP requests with method control:</p>
117117
<pre><code><span class="code-comment">(* GET request *)</span>
118-
<span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;data&gt;</span> from the &lt;api-url&gt;.
118+
<span class="code-keyword">Request</span> the <span class="code-result">&lt;data&gt;</span> from the &lt;api-url&gt;.
119119

120120
<span class="code-comment">(* POST request with data *)</span>
121-
<span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;result&gt;</span> to the &lt;api-url&gt; with &lt;payload&gt;.
121+
<span class="code-keyword">Request</span> the <span class="code-result">&lt;result&gt;</span> to the &lt;api-url&gt; with &lt;payload&gt;.
122122

123123
<span class="code-comment">(* Explicit method *)</span>
124-
<span class="code-keyword">&lt;Request&gt;</span> the <span class="code-result">&lt;result&gt;</span> via PUT the &lt;url&gt; with &lt;update&gt;.</code></pre>
124+
<span class="code-keyword">Request</span> the <span class="code-result">&lt;result&gt;</span> via PUT the &lt;url&gt; with &lt;update&gt;.</code></pre>
125125

126126
<h3>Exec</h3>
127127
<p>Execute shell commands (ARO-0033):</p>
128-
<pre><code><span class="code-keyword">&lt;Exec&gt;</span> the <span class="code-result">&lt;result&gt;</span> for the &lt;command&gt; with <span class="code-string">"ls -la"</span>.
129-
<span class="code-keyword">&lt;Exec&gt;</span> the <span class="code-result">&lt;output&gt;</span> on the &lt;system&gt; with {
128+
<pre><code><span class="code-keyword">Exec</span> the <span class="code-result">&lt;result&gt;</span> for the &lt;command&gt; with <span class="code-string">"ls -la"</span>.
129+
<span class="code-keyword">Exec</span> the <span class="code-result">&lt;output&gt;</span> on the &lt;system&gt; with {
130130
command: <span class="code-string">"npm install"</span>,
131131
workingDirectory: <span class="code-string">"/app"</span>,
132132
timeout: 60000
@@ -289,18 +289,18 @@ <h3>Write</h3>
289289

290290
<h3>Append</h3>
291291
<p>Append content to files:</p>
292-
<pre><code><span class="code-keyword">&lt;Append&gt;</span> the &lt;log-line&gt; to the &lt;file: <span class="code-string">"./app.log"</span>&gt;.
293-
<span class="code-keyword">&lt;Append&gt;</span> the &lt;entry&gt; to the &lt;file: <span class="code-string">"./data.csv"</span>&gt;.</code></pre>
292+
<pre><code><span class="code-keyword">Append</span> the &lt;log-line&gt; to the &lt;file: <span class="code-string">"./app.log"</span>&gt;.
293+
<span class="code-keyword">Append</span> the &lt;entry&gt; to the &lt;file: <span class="code-string">"./data.csv"</span>&gt;.</code></pre>
294294

295295
<h2>File Operations</h2>
296296
<p>Actions for file system operations (ARO-0036).</p>
297297

298298
<h3>List</h3>
299299
<p>List directory contents:</p>
300300
<pre><code><span class="code-keyword">Create</span> the &lt;dir-path&gt; with <span class="code-string">"./uploads"</span>.
301-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;entries&gt;</span> from the &lt;directory: dir-path&gt;.
302-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;aro-files&gt;</span> from the &lt;directory: src-path&gt; matching <span class="code-string">"*.aro"</span>.
303-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;all-files&gt;</span> from the &lt;directory: path&gt; recursively.</code></pre>
301+
<span class="code-keyword">List</span> the <span class="code-result">&lt;entries&gt;</span> from the &lt;directory: dir-path&gt;.
302+
<span class="code-keyword">List</span> the <span class="code-result">&lt;aro-files&gt;</span> from the &lt;directory: src-path&gt; matching <span class="code-string">"*.aro"</span>.
303+
<span class="code-keyword">List</span> the <span class="code-result">&lt;all-files&gt;</span> from the &lt;directory: path&gt; recursively.</code></pre>
304304

305305
<h3>Stat</h3>
306306
<p>Get file or directory metadata:</p>
@@ -314,7 +314,7 @@ <h3>Exists</h3>
314314

315315
<h3>CreateDirectory</h3>
316316
<p>Create directories (with parent directories):</p>
317-
<pre><code><span class="code-keyword">&lt;CreateDirectory&gt;</span> the <span class="code-result">&lt;output-dir&gt;</span> to the &lt;path: <span class="code-string">"./output/reports/2024"</span>&gt;.</code></pre>
317+
<pre><code><span class="code-keyword">CreateDirectory</span> the <span class="code-result">&lt;output-dir&gt;</span> to the &lt;path: <span class="code-string">"./output/reports/2024"</span>&gt;.</code></pre>
318318

319319
<h3>Copy</h3>
320320
<p>Copy files or directories:</p>
@@ -336,16 +336,16 @@ <h3>Start</h3>
336336

337337
<h3>Watch</h3>
338338
<p>Monitor a directory:</p>
339-
<pre><code><span class="code-keyword">&lt;Watch&gt;</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;file-monitor&gt;.</code></pre>
339+
<pre><code><span class="code-keyword">Watch</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;file-monitor&gt;.</code></pre>
340340

341341
<h3>Listen / Connect</h3>
342342
<pre><code><span class="code-keyword">Listen</span> on port 9000 as &lt;socket-server&gt;.
343343
<span class="code-keyword">Connect</span> to &lt;host: <span class="code-string">"localhost"</span>&gt; on port 5432 as &lt;database&gt;.</code></pre>
344344

345345
<h3>Close</h3>
346346
<p>Close connections:</p>
347-
<pre><code><span class="code-keyword">&lt;Close&gt;</span> the &lt;connection&gt;.
348-
<span class="code-keyword">&lt;Close&gt;</span> the &lt;socket-server&gt;.</code></pre>
347+
<pre><code><span class="code-keyword">Close</span> the &lt;connection&gt;.
348+
<span class="code-keyword">Close</span> the &lt;socket-server&gt;.</code></pre>
349349

350350
<h3>Broadcast</h3>
351351
<p>Send to all connections:</p>
@@ -375,14 +375,14 @@ <h2>Test Actions</h2>
375375

376376
<h3>Given / When / Then</h3>
377377
<p>BDD-style test structure:</p>
378-
<pre><code><span class="code-keyword">&lt;Given&gt;</span> the &lt;user&gt; with { name: <span class="code-string">"Test"</span> }.
379-
<span class="code-keyword">&lt;When&gt;</span> the &lt;action&gt; is performed.
380-
<span class="code-keyword">&lt;Then&gt;</span> the &lt;result&gt; should be &lt;expected&gt;.</code></pre>
378+
<pre><code><span class="code-keyword">Given</span> the &lt;user&gt; with { name: <span class="code-string">"Test"</span> }.
379+
<span class="code-keyword">When</span> the &lt;action&gt; is performed.
380+
<span class="code-keyword">Then</span> the &lt;result&gt; should be &lt;expected&gt;.</code></pre>
381381

382382
<h3>Assert</h3>
383383
<p>Assert conditions:</p>
384-
<pre><code><span class="code-keyword">&lt;Assert&gt;</span> the &lt;value&gt; equals &lt;expected&gt;.
385-
<span class="code-keyword">&lt;Assert&gt;</span> the &lt;list&gt; contains &lt;item&gt;.</code></pre>
384+
<pre><code><span class="code-keyword">Assert</span> the &lt;value&gt; equals &lt;expected&gt;.
385+
<span class="code-keyword">Assert</span> the &lt;list&gt; contains &lt;item&gt;.</code></pre>
386386

387387
<h2>Action Patterns</h2>
388388

Website/src/docs/ai-development-guide.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ <h2>ARO Syntax Quick Reference</h2>
148148

149149
<h3>Feature Set</h3>
150150
<pre><code>(Feature Name: Business Activity) {
151-
&lt;Action&gt; the &lt;result&gt; from/with/to the &lt;object&gt;.
151+
Action the &lt;result&gt; from/with/to the &lt;object&gt;.
152152
Return an &lt;OK: status&gt; with &lt;result&gt;.
153153
}</code></pre>
154154

Website/src/docs/application-lifecycle.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ <h3>Full Example</h3>
122122
<span class="code-keyword">Start</span> the &lt;http-server&gt; on port &lt;config: server port&gt;.
123123

124124
<span class="code-comment">(* Start file watcher for uploads *)</span>
125-
<span class="code-keyword">&lt;Watch&gt;</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;upload-watcher&gt;.
125+
<span class="code-keyword">Watch</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;upload-watcher&gt;.
126126

127127
<span class="code-comment">(* Keep the application running *)</span>
128128
<span class="code-keyword">Keepalive</span> the &lt;application&gt; for the &lt;events&gt;.
@@ -209,7 +209,7 @@ <h3>HTTP Server</h3>
209209

210210
<h3>File Watcher</h3>
211211
<pre><code><span class="code-feature">(Application-Start: File Processor)</span> {
212-
<span class="code-keyword">&lt;Watch&gt;</span> the &lt;directory: <span class="code-string">"./inbox"</span>&gt; as &lt;file-watcher&gt;.
212+
<span class="code-keyword">Watch</span> the &lt;directory: <span class="code-string">"./inbox"</span>&gt; as &lt;file-watcher&gt;.
213213
<span class="code-keyword">Keepalive</span> the &lt;application&gt; for the &lt;events&gt;.
214214
<span class="code-keyword">Return</span> an <span class="code-result">&lt;OK: status&gt;</span> for the &lt;startup&gt;.
215215
}</code></pre>
@@ -230,7 +230,7 @@ <h3>Multiple Services</h3>
230230
<span class="code-keyword">Listen</span> on port 8081 as &lt;websocket-server&gt;.
231231

232232
<span class="code-comment">(* File watcher *)</span>
233-
<span class="code-keyword">&lt;Watch&gt;</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;upload-watcher&gt;.
233+
<span class="code-keyword">Watch</span> the &lt;directory: <span class="code-string">"./uploads"</span>&gt; as &lt;upload-watcher&gt;.
234234

235235
<span class="code-comment">(* Keep the application running *)</span>
236236
<span class="code-keyword">Keepalive</span> the &lt;application&gt; for the &lt;events&gt;.
@@ -241,7 +241,7 @@ <h3>Multiple Services</h3>
241241
<span class="code-feature">(Application-End: Success)</span> {
242242
<span class="code-comment">(* Stop in reverse order *)</span>
243243
<span class="code-keyword">Stop</span> the &lt;upload-watcher&gt;.
244-
<span class="code-keyword">&lt;Close&gt;</span> the &lt;websocket-server&gt;.
244+
<span class="code-keyword">Close</span> the &lt;websocket-server&gt;.
245245
<span class="code-keyword">Stop</span> the &lt;http-server&gt;.
246246

247247
<span class="code-keyword">Return</span> an <span class="code-result">&lt;OK: status&gt;</span> for the &lt;shutdown&gt;.

Website/src/docs/custom-actions.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ <h1 class="gradient-text">Creating Custom Actions</h1>
6868
<h2>Understanding Actions</h2>
6969
<p>In ARO, every statement follows the Action-Result-Object pattern:</p>
7070

71-
<pre><code>&lt;Verb&gt; the &lt;result&gt; from/to/with/for the &lt;object&gt;.</code></pre>
71+
<pre><code>Verb the &lt;result&gt; from/to/with/for the &lt;object&gt;.</code></pre>
7272

7373
<p>Each verb maps to an action implementation that:</p>
7474
<ol>
@@ -201,7 +201,7 @@ <h3>Step 4: Use in ARO</h3>
201201
body: <span class="code-string">"Thanks for signing up..."</span>
202202
}.
203203
Extract the &lt;user-email&gt; from the &lt;user: email&gt;.
204-
&lt;Email&gt; the &lt;email-content&gt; to the &lt;user-email&gt;.
204+
Email the &lt;email-content&gt; to the &lt;user-email&gt;.
205205
Return an &lt;OK: status&gt; for the &lt;email&gt;.
206206
}</code></pre>
207207

@@ -284,7 +284,7 @@ <h2>Example: External API Action</h2>
284284
}</code></pre>
285285

286286
<p>Usage:</p>
287-
<pre><code>&lt;Weather&gt; the &lt;forecast&gt; for the &lt;city&gt;.</code></pre>
287+
<pre><code>Weather the &lt;forecast&gt; for the &lt;city&gt;.</code></pre>
288288

289289
<div class="highlight-box">
290290
<h4>Summary</h4>

Website/src/docs/event-driven.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,15 +263,15 @@ <h2>Event Handlers</h2>
263263
<span class="code-keyword">Extract</span> the <span class="code-result">&lt;items&gt;</span> from the <span class="code-result">&lt;event: items&gt;</span>.
264264

265265
for each &lt;item&gt; in &lt;items&gt; {
266-
<span class="code-keyword">&lt;Decrement&gt;</span> the &lt;stock&gt; for the &lt;item: productId&gt;.
266+
<span class="code-keyword">Decrement</span> the &lt;stock&gt; for the &lt;item: productId&gt;.
267267
}
268268

269269
<span class="code-keyword">Return</span> an <span class="code-result">&lt;OK: status&gt;</span> for the &lt;inventory&gt;.
270270
}
271271

272272
<span class="code-feature">(Track Revenue: Analytics)</span> {
273273
<span class="code-keyword">Extract</span> the <span class="code-result">&lt;amount&gt;</span> from the <span class="code-result">&lt;event: amount&gt;</span>.
274-
<span class="code-keyword">&lt;Increment&gt;</span> the &lt;daily-revenue&gt; by &lt;amount&gt;.
274+
<span class="code-keyword">Increment</span> the &lt;daily-revenue&gt; by &lt;amount&gt;.
275275
<span class="code-keyword">Return</span> an <span class="code-result">&lt;OK: status&gt;</span> for the &lt;analytics&gt;.
276276
}</code></pre>
277277

Website/src/docs/file-operations.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -267,19 +267,19 @@ <h3>Write Files</h3>
267267

268268
<h3>Append to Files</h3>
269269
<pre><code><span class="code-comment">(* Append to log file *)</span>
270-
<span class="code-keyword">&lt;Append&gt;</span> the <span class="code-result">&lt;log-line&gt;</span> to the &lt;file: <span class="code-string">"./logs/app.log"</span>&gt;.</code></pre>
270+
<span class="code-keyword">Append</span> the <span class="code-result">&lt;log-line&gt;</span> to the &lt;file: <span class="code-string">"./logs/app.log"</span>&gt;.</code></pre>
271271

272272
<h2>Directory Operations</h2>
273273

274274
<h3>List Directory Contents</h3>
275275
<pre><code><span class="code-comment">(* List all entries *)</span>
276-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;entries&gt;</span> in the &lt;directory: <span class="code-string">"./uploads"</span>&gt;.
276+
<span class="code-keyword">List</span> the <span class="code-result">&lt;entries&gt;</span> in the &lt;directory: <span class="code-string">"./uploads"</span>&gt;.
277277

278278
<span class="code-comment">(* Filter with glob pattern *)</span>
279-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;aro-files&gt;</span> in the &lt;directory: <span class="code-string">"./src"</span>&gt; matching <span class="code-string">"*.aro"</span>.
279+
<span class="code-keyword">List</span> the <span class="code-result">&lt;aro-files&gt;</span> in the &lt;directory: <span class="code-string">"./src"</span>&gt; matching <span class="code-string">"*.aro"</span>.
280280

281281
<span class="code-comment">(* List recursively *)</span>
282-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;all-files&gt;</span> in the &lt;directory: <span class="code-string">"./project"</span>&gt; recursively.</code></pre>
282+
<span class="code-keyword">List</span> the <span class="code-result">&lt;all-files&gt;</span> in the &lt;directory: <span class="code-string">"./project"</span>&gt; recursively.</code></pre>
283283

284284
<p>Each entry includes:</p>
285285
<ul>
@@ -303,7 +303,7 @@ <h3>Check Existence</h3>
303303

304304
<h3>Create Directories</h3>
305305
<pre><code><span class="code-comment">(* Create directory with all parent directories *)</span>
306-
<span class="code-keyword">&lt;CreateDirectory&gt;</span> the <span class="code-result">&lt;output-dir&gt;</span> to the &lt;path: <span class="code-string">"./output/reports/2024"</span>&gt;.</code></pre>
306+
<span class="code-keyword">CreateDirectory</span> the <span class="code-result">&lt;output-dir&gt;</span> to the &lt;path: <span class="code-string">"./output/reports/2024"</span>&gt;.</code></pre>
307307

308308
<h3>Get File Metadata</h3>
309309
<pre><code><span class="code-comment">(* Get detailed file stats *)</span>
@@ -340,7 +340,7 @@ <h2>Complete Example</h2>
340340
<span class="code-keyword">Exists</span> the <span class="code-result">&lt;dir-exists&gt;</span> for the &lt;directory: <span class="code-string">"./demo-output"</span>&gt;.
341341

342342
when &lt;dir-exists&gt; is false {
343-
<span class="code-keyword">&lt;CreateDirectory&gt;</span> the <span class="code-result">&lt;output&gt;</span> to the &lt;path: <span class="code-string">"./demo-output"</span>&gt;.
343+
<span class="code-keyword">CreateDirectory</span> the <span class="code-result">&lt;output&gt;</span> to the &lt;path: <span class="code-string">"./demo-output"</span>&gt;.
344344
<span class="code-keyword">Log</span> <span class="code-string">"Created directory"</span> to the &lt;console&gt;.
345345
}
346346

@@ -349,7 +349,7 @@ <h2>Complete Example</h2>
349349
with <span class="code-string">"Hello from ARO!"</span>.
350350

351351
<span class="code-comment">(* Append to it *)</span>
352-
<span class="code-keyword">&lt;Append&gt;</span> the <span class="code-result">&lt;line&gt;</span> to the &lt;file: <span class="code-string">"./demo-output/hello.txt"</span>&gt;
352+
<span class="code-keyword">Append</span> the <span class="code-result">&lt;line&gt;</span> to the &lt;file: <span class="code-string">"./demo-output/hello.txt"</span>&gt;
353353
with <span class="code-string">"\nAppended line."</span>.
354354

355355
<span class="code-comment">(* Get stats *)</span>
@@ -361,7 +361,7 @@ <h2>Complete Example</h2>
361361
to the &lt;destination: <span class="code-string">"./demo-output/hello-copy.txt"</span>&gt;.
362362

363363
<span class="code-comment">(* List directory *)</span>
364-
<span class="code-keyword">&lt;List&gt;</span> the <span class="code-result">&lt;files&gt;</span> in the &lt;directory: <span class="code-string">"./demo-output"</span>&gt;.
364+
<span class="code-keyword">List</span> the <span class="code-result">&lt;files&gt;</span> in the &lt;directory: <span class="code-string">"./demo-output"</span>&gt;.
365365

366366
<span class="code-keyword">Log</span> <span class="code-string">"=== Complete ==="</span> to the &lt;console&gt;.
367367
<span class="code-keyword">Return</span> an <span class="code-result">&lt;OK: status&gt;</span> for the &lt;demo&gt;.

0 commit comments

Comments
 (0)