@greenpandastudios/aug-cli 0.19.0 → 0.20.1

package/docs/examples/interceptors/interceptors.md

@@ -31,6 +31,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "interceptors.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 import Logger from logging
 /** Raised when a numeric input fails validation. */
@@ -43,7 +44,7 @@ ValidationError(string message) implements Error:
 */
 interceptor Audit<T>(resolve Logger logger):
     /** Wrap a call without changing its result. */
-    around(resolve Console console) returns T uses Console.write:
+    around(resolve Console console):
         logger.log(message="before")
         T result = next()
         logger.log(message="after")
@@ -54,7 +55,7 @@ interceptor Positive<T>():
     * @param y The target argument selected by a mapping such as y=x.
     * @throws ValidationError When the selected value is negative.
     */
-    around(int y) returns T unless ValidationError:
+    around(int y) returns T:
         if y < 0:
             throw ValidationError(message="value must be nonnegative")
         return next()
@@ -66,6 +67,7 @@ interceptor AddOne<T>():
 ```
 
 ```aug [Braces]
+// aug-spec: "interceptors.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 import Logger from logging
 /** Raised when a numeric input fails validation. */
@@ -79,7 +81,7 @@ ValidationError(string message) implements Error {
 */
 interceptor Audit<T>(resolve Logger logger) {
     /** Wrap a call without changing its result. */
-    around(resolve Console console) returns T uses Console.write {
+    around(resolve Console console) {
         logger.log(message="before")
         T result = next()
         logger.log(message="after")
@@ -92,7 +94,7 @@ interceptor Positive<T>() {
     * @param y The target argument selected by a mapping such as y=x.
     * @throws ValidationError When the selected value is negative.
     */
-    around(int y) returns T unless ValidationError {
+    around(int y) returns T {
         if y < 0 {
             throw ValidationError(message="value must be nonnegative")
         }
@@ -116,168 +118,42 @@ interceptor AddOne<T>() {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
-
-### In this file
-
-- [`ValidationError`](interceptors.md#symbol-ValidationError) is a class implementing `Error`.
-- [`Audit`](interceptors.md#symbol-Audit) is an interceptor.
-- [`Positive`](interceptors.md#symbol-Positive) is an interceptor.
-- [`AddOne`](interceptors.md#symbol-AddOne) is an interceptor.
-
-### `ValidationError` {#symbol-ValidationError}
-
-[source](interceptors.md#code)
-
-Behavioral class.
-
-Satisfies `Error`.
-
-**Author documentation**
-
-Raised when a numeric input fails validation.
-
-**Inputs**
-
-- `message` (`string`) — required labeled input — stored as `message` and read-only after initialization.
-
-### `Audit` {#symbol-Audit}
-
-[source](interceptors.md#code)
-
-Function or constructor middleware.
+### `ValidationError` · class · [source](interceptors.md#code) {#symbol-ValidationError}
 
-Type parameters: `T`.
+Raised when a numeric input fails validation. It implements `Error`. It takes `message` as a string, kept read-only.
 
-**Author documentation**
+### `Audit` · interceptor · [source](interceptors.md#code) {#symbol-Audit}
 
 Logs before and after a successful call.
-Generic T is inferred from the annotated function or constructor.
-
-**Parameters**
-- `logger`: Shared application logger, injected for each fresh instance.
-
-**Inputs**
-
-- `logger` ([`Logger`](logging.md#symbol-Logger)) — injected; callers omit it — stored as `logger` and read-only after initialization.
-
-Create a fresh interceptor for each invocation. Its around operation can delegate once, change selected inputs, or short-circuit with a compatible result or failure.
-
-#### `Audit.around` {#symbol-Audit.around}
-
-[source](interceptors.md#code)
-
-**Inputs**
-
-- `console` ([`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it.
-
-Returns: `T`.
-
-Capabilities: [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
-
-**What it does**
-
-- Call [`Logger.log`](logging.md#symbol-Logger.log) on `logger` with `message` = `"before"`; inject `console` from `console`.
-- Set `result` of type `T` to call `next`.
-- Call [`Logger.log`](logging.md#symbol-Logger.log) on `logger` with `message` = `"after"`; inject `console` from `console`.
-- Return `result`.
-
-**Author documentation**
-
-Wrap a call without changing its result.
-
-### `Positive` {#symbol-Positive}
-
-[source](interceptors.md#code)
-
-Function or constructor middleware.
-
-Type parameters: `T`.
-
-**Author documentation**
-
-Rejects negative numbers before the target executes.
-
-Create a fresh interceptor for each invocation. Its around operation can delegate once, change selected inputs, or short-circuit with a compatible result or failure.
-
-#### `Positive.around` {#symbol-Positive.around}
-
-[source](interceptors.md#code)
-
-**Inputs**
-
-- `y` (`int`) — required labeled input.
-
-Returns: `T`.
-
-Can fail with `ValidationError`. Callers must catch or propagate these errors.
-
-**What it does**
-
-- If `y` is less than `0`:
-  - Fail with call [`ValidationError`](interceptors.md#symbol-ValidationError) with `message` = `"value must be nonnegative"`. Transfer control to a matching catch or propagate the failure.
-- Return call `next`.
-
-**Author documentation**
-
-**Parameters**
-- `y`: The target argument selected by a mapping such as y=x.
-
-**Throws**
-- `ValidationError`: When the selected value is negative.
-
-### `AddOne` {#symbol-AddOne}
-
-[source](interceptors.md#code)
-
-Function or constructor middleware.
-
-Type parameters: `T`.
-
-**Author documentation**
-
-Adds one to the selected input before forwarding the call.
-
-Create a fresh interceptor for each invocation. Its around operation can delegate once, change selected inputs, or short-circuit with a compatible result or failure.
-
-#### `AddOne.around` {#symbol-AddOne.around}
-
-[source](interceptors.md#code)
-
-**Inputs**
-
-- `y` (`int`) — required labeled input.
-
-Returns: `T`.
+Generic T is inferred from the annotated function or constructor. The type parameters are `T`.
 
-**What it does**
+The `logger` dependency is injected as [`Logger`](logging.md#symbol-Logger) and stored read-only. Creates one interceptor per invocation. Its around operation may delegate once or finish early.
 
-- Return call `next` with `y` = (`y` plus `1`).
+#### `Audit.around` · [source](interceptors.md#code) {#symbol-Audit.around}
 
-**Author documentation**
+Wrap a call without changing its result. It gets `console` ([`Console`](dependencies/august/0.20.1/io/contracts.md#symbol-Console)) from dependency injection.
 
-**Parameters**
-- `y`: The input to increment.
+It passes `"before"` to [`logger.log`](logging.md#symbol-Logger.log), using injected `console`. It sets `result` of type `T` to `next`. It passes `"after"` to [`logger.log`](logging.md#symbol-Logger.log), using injected `console`. It returns `result`.
 
-### Dependencies used by this file
+### `Positive` · interceptor · [source](interceptors.md#code) {#symbol-Positive}
 
-Only referenced types and operations appear here. Each name links to its complete specification.
+Rejects negative numbers before the target executes. The type parameters are `T`. Creates one interceptor per invocation. Its around operation may delegate once or finish early.
 
-#### [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)
+#### `Positive.around` · [source](interceptors.md#code) {#symbol-Positive.around}
 
-Capability interface from `august.io`.
+It takes `y` as an integer (the target argument selected by a mapping such as y=x). Failures can raise [`ValidationError`](interceptors.md#symbol-ValidationError) (when the selected value is negative). If `y` is negative, it raises a [`ValidationError`](interceptors.md#symbol-ValidationError) with `message` `"value must be nonnegative"`. It returns `next`.
 
-- [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write)<`T`> (`value`: `T`) → `void`.
+### `AddOne` · interceptor · [source](interceptors.md#code) {#symbol-AddOne}
 
-#### [`Logger`](logging.md#symbol-Logger)
+Adds one to the selected input before forwarding the call. The type parameters are `T`. Creates one interceptor per invocation. Its around operation may delegate once or finish early.
 
-Interface from `logging`.
+#### `AddOne.around` · [source](interceptors.md#code) {#symbol-AddOne.around}
 
-- [`Logger.log`](logging.md#symbol-Logger.log) (`message`: `string`) → `void`; inject `console`: [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console); uses [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
+It takes `y` as an integer (the input to increment). It returns `next` with `y` from `y` plus `1`.
 
-### Shared language rules
+### Dependencies
 
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It uses [`Console`](dependencies/august/0.20.1/io/contracts.md#symbol-Console) ([`write`](dependencies/august/0.20.1/io/contracts.md#symbol-Console.write)) from `august.io`. It uses [`Logger`](logging.md#symbol-Logger) ([`log`](logging.md#symbol-Logger.log)) from `logging`.
 
 ::::
 

package/docs/examples/interceptors/logging.md

@@ -31,6 +31,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "logging.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 /** Writes a message to the application log. */
 interface Logger:
@@ -38,11 +39,12 @@ interface Logger:
     log(resolve Console console, string message) uses Console.write
 /** Console logger shared by interceptor instances and the application. */
 ConsoleLogger() implements Logger:
-    log(resolve Console console, string message) uses Console.write:
+    log(resolve Console console, string message):
         console.write(value=message)
 ```
 
 ```aug [Braces]
+// aug-spec: "logging.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console from august.io
 /** Writes a message to the application log. */
 interface Logger {
@@ -51,7 +53,7 @@ interface Logger {
 }
 /** Console logger shared by interceptor instances and the application. */
 ConsoleLogger() implements Logger {
-    log(resolve Console console, string message) uses Console.write {
+    log(resolve Console console, string message) {
         console.write(value=message)
     }
 }
@@ -65,90 +67,25 @@ ConsoleLogger() implements Logger {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
-
-### In this file
-
-- [`Logger`](logging.md#symbol-Logger) is an interface.
-- [`ConsoleLogger`](logging.md#symbol-ConsoleLogger) is a class implementing `Logger`.
-
-### `Logger` {#symbol-Logger}
-
-[source](logging.md#code)
-
-Interface.
-
-**Author documentation**
+### `Logger` · interface · [source](logging.md#code) {#symbol-Logger}
 
 Writes a message to the application log.
 
-#### `Logger.log` {#symbol-Logger.log}
-
-[source](logging.md#code)
-
-**Inputs**
-
-- `console` ([`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it.
-- `message` (`string`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
-
-Interface contract. A selected implementation supplies the behavior.
-
-**Author documentation**
-
-**Parameters**
-- `message`: Text to display.
-
-### `ConsoleLogger` {#symbol-ConsoleLogger}
-
-[source](logging.md#code)
-
-Behavioral class.
-
-Satisfies [`Logger`](logging.md#symbol-Logger).
-
-**Author documentation**
-
-Console logger shared by interceptor instances and the application.
-
-#### `ConsoleLogger.log` {#symbol-ConsoleLogger.log}
-
-[source](logging.md#code)
-
-**Inputs**
-
-- `console` ([`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)) — injected; callers omit it.
-- `message` (`string`) — required labeled input.
-
-Returns: no value.
-
-Capabilities: [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
-
-**What it does**
-
-- Call [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write) on `console` with `value` = `message`.
-
-**Author documentation**
-
-**Parameters**
-- `message`: Text to display.
+#### `Logger.log` · [source](logging.md#code) {#symbol-Logger.log}
 
-### Dependencies used by this file
+It takes `message` as a string (Text to display). It gets `console` ([`Console`](dependencies/august/0.20.1/io/contracts.md#symbol-Console)) from dependency injection. It can call [`Console.write`](dependencies/august/0.20.1/io/contracts.md#symbol-Console.write).
 
-Only referenced types and operations appear here. Each name links to its complete specification.
+### `ConsoleLogger` · class · [source](logging.md#code) {#symbol-ConsoleLogger}
 
-#### [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console)
+Console logger shared by interceptor instances and the application. It implements [`Logger`](logging.md#symbol-Logger).
 
-Capability interface from `august.io`.
+#### `ConsoleLogger.log` · [source](logging.md#code) {#symbol-ConsoleLogger.log}
 
-- [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write)<`T`> (`value`: `T`) → `void`.
+It takes `message` as a string (Text to display). It gets `console` ([`Console`](dependencies/august/0.20.1/io/contracts.md#symbol-Console)) from dependency injection. It passes `message` to [`console.write`](dependencies/august/0.20.1/io/contracts.md#symbol-Console.write).
 
-### Shared language rules
+### Dependencies
 
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It uses [`Console`](dependencies/august/0.20.1/io/contracts.md#symbol-Console) ([`write`](dependencies/august/0.20.1/io/contracts.md#symbol-Console.write)) from `august.io`.
 
 ::::
 

package/docs/examples/interceptors/main.md

@@ -31,6 +31,7 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console and SystemConsole from august.io
 implement Console with SystemConsole
 import Logger from logging
@@ -52,6 +53,7 @@ catch ValidationError error:
 ```
 
 ```aug [Braces]
+// aug-spec: "main.aug.md" explains this file. Read it before changes; refresh with aug spec.
 import Console and SystemConsole from august.io
 implement Console with SystemConsole
 import Logger from logging
@@ -84,78 +86,21 @@ catch ValidationError error {
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### Providers
 
-### In this file
+`Console` is provided by [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole). The same instance is shared. `Logger` is provided by [`ConsoleLogger`](logging.md#symbol-ConsoleLogger). The same instance is shared.
 
-- Register 2 dependency providers before startup.
-- Run startup operations with checked error recovery.
-- Run 2 other startup steps in source order.
+### Startup
 
-### Dependency providers
+It prints [`describe`](app.md#symbol-describe) with `label` `"value"` and `x` `6` using injected `Logger` for `logger` and `Console` for `console`. If this work raises [`ValidationError`](interceptors.md#symbol-ValidationError), it prints `"rejected"`. It sets `greeter` to a [`Greeter`](app.md#symbol-Greeter) with `name` `"AugScript"` using injected `Logger` for `_logger`. It prints [`greeter.greet`](app.md#symbol-Greeter.greet) using injected `Logger` for `logger` and `Console` for `console`.
 
-Register these providers before startup. Their declaration order does not set initialization order; shared instances initialize in dependency order.
+It tries to call [`describe`](app.md#symbol-describe) with `x` `-1` and `label` `"invalid"` using injected `Logger` for `logger` and `Console` for `console`. If this work raises [`ValidationError`](interceptors.md#symbol-ValidationError), it prints `"rejected"`.
 
-- Provide [`SystemConsole`](dependencies/august/0.19.0/io/contracts.md#symbol-SystemConsole) when `Console` is requested. Reuse one instance.
-- Provide [`ConsoleLogger`](logging.md#symbol-ConsoleLogger) when `Logger` is requested. Reuse one instance.
+### Dependencies
 
-### Startup, in source order
+It uses [`SystemConsole`](dependencies/august/0.20.1/io/contracts.md#symbol-SystemConsole) from `august.io`. It uses [`Greeter`](app.md#symbol-Greeter) ([`greet`](app.md#symbol-Greeter.greet)) and [`describe`](app.md#symbol-describe) from `app`. It uses [`ValidationError`](interceptors.md#symbol-ValidationError) from `interceptors`. It uses [`ConsoleLogger`](logging.md#symbol-ConsoleLogger) from `logging`.
 
-- Try these operations:
-  - Call `print` with `value` = call [`describe`](app.md#symbol-describe) with `label` = `"value"`; `x` = `6`; inject `logger` from `Logger`, `console` from `Console`.
-- If they fail with [`ValidationError`](interceptors.md#symbol-ValidationError), name the failure `error` and recover:
-  - Call `print` with `value` = `"rejected"`.
-- Set `greeter` to call [`Greeter`](app.md#symbol-Greeter) with `name` = `"AugScript"`; inject `_logger` from `Logger`.
-- Call `print` with `value` = call [`Greeter.greet`](app.md#symbol-Greeter.greet) on `greeter`; inject `logger` from `Logger`, `console` from `Console`.
-- Try these operations:
-  - Call [`describe`](app.md#symbol-describe) with `x` = `-1`; `label` = `"invalid"`; inject `logger` from `Logger`, `console` from `Console`.
-- If they fail with [`ValidationError`](interceptors.md#symbol-ValidationError), name the failure `error` and recover:
-  - Call `print` with `value` = `"rejected"`.
-
-### Dependencies used by this file
-
-Only referenced types and operations appear here. Each name links to its complete specification.
-
-#### [`SystemConsole`](dependencies/august/0.19.0/io/contracts.md#symbol-SystemConsole)
-
-Class from `august.io`.
-
-Used as a type or provider.
-
-#### [`Greeter`](app.md#symbol-Greeter)
-
-Class from `app`.
-
-- Construct with `name`: `string` → [`Greeter`](app.md#symbol-Greeter).
-- [`Greeter.greet`](app.md#symbol-Greeter.greet) (no caller inputs) → `string`; inject `logger`: [`Logger`](logging.md#symbol-Logger), `console`: [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console); uses [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write).
-
-#### [`describe`](app.md#symbol-describe)
-
-Function from `app`.
-
-- [`describe`](app.md#symbol-describe) (`x`: `int`, `label`: `string`) → `string`; inject `logger`: [`Logger`](logging.md#symbol-Logger), `console`: [`Console`](dependencies/august/0.19.0/io/contracts.md#symbol-Console); uses [`Console.write`](dependencies/august/0.19.0/io/contracts.md#symbol-Console.write); can fail with `ValidationError`.
-
-#### [`ValidationError`](interceptors.md#symbol-ValidationError)
-
-Class from `interceptors`.
-
-Used as a type or provider.
-
-#### [`ConsoleLogger`](logging.md#symbol-ConsoleLogger)
-
-Class from `logging`.
-
-Used as a type or provider.
-
-### Built-in operations used by this file
-
-- `print` (`value`: `any`) → `void`: Composition and test output. Other callables receive Console and declare uses console.write.
-
-[Full built-in reference](https://greenpandastudios.github.io/augscript/language-constructs).
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+Built-in operations follow the [language reference](https://greenpandastudios.github.io/augscript/language-constructs).
 
 ::::
 

package/docs/examples/json-benchmark/data.md

@@ -29,10 +29,12 @@ pageClass: aug-example-page
 ::: code-group
 
 ```aug [Indentation]
+// aug-spec: "data.aug.md" explains this file. Read it before changes; refresh with aug spec.
 record Payload(int id, string message, List<int> values)
 ```
 
 ```aug [Braces]
+// aug-spec: "data.aug.md" explains this file. Read it before changes; refresh with aug spec.
 record Payload(int id, string message, List<int> values)
 ```
 
@@ -44,27 +46,9 @@ record Payload(int id, string message, List<int> values)
 
 ## Compiled specification {#specification}
 
-August 0.19.0. This document is compiled from checked code with deterministic wording guided by Simplified Technical English.
+### `Payload` · immutable record · [source](data.md#code) {#symbol-Payload}
 
-### In this file
-
-- [`Payload`](data.md#symbol-Payload) is an immutable record.
-
-### `Payload` {#symbol-Payload}
-
-[source](data.md#code)
-
-Immutable record.
-
-**Inputs**
-
-- `id` (`int`) — required labeled input — stored as `id` and read-only after initialization.
-- `message` (`string`) — required labeled input — stored as `message` and read-only after initialization.
-- `values` (`List<int>`) — required labeled input — stored as `values` and read-only after initialization.
-
-### Shared language rules
-
-See the [language reference](https://greenpandastudios.github.io/augscript/reference) for numeric, equality, ownership, and task rules.
+It takes `id` as an integer, kept read-only, `message` as a string, kept read-only, and `values` as `List<int>`, kept read-only.
 
 ::::
 

package/docs/examples/json-benchmark/dependencies/packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.md

@@ -0,0 +1,67 @@
+---
+title: "packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug · JSON benchmark"
+generated: true
+source: "benchmarks/json/.aug-spec/packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+search: false
+pageClass: aug-example-page
+---
+
+# `packages/@git/url_2d3c37c690c0fa115be1/0.0.0-git.a39fc582565d4fca40be4f75fa304d71adc69301/contracts.aug`
+
+[JSON benchmark](../../../../../index.md) · Dependency source and specification
+
+This is the exact dependency version used by this example.
+
+::::: example-compare
+
+:::: example-code
+
+## Code {#code}
+
+::: code-group
+
+```aug [Indentation]
+extern C value pure _aug_json_parse(string input) returns Json unless JsonError
+/** Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError. */
+parse(string input) returns Json unless JsonError:
+    unsafe:
+        return _aug_json_parse(input)
+```
+
+```aug [Braces]
+extern C value pure _aug_json_parse(string input) returns Json unless JsonError
+/** Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError. */
+parse(string input) returns Json unless JsonError {
+    unsafe {
+        return _aug_json_parse(input)
+    }
+}
+```
+
+:::
+
+::::
+
+:::: example-spec
+
+## Compiled specification {#specification}
+
+### `parse` · [source](contracts.md#code) {#symbol-parse}
+
+Parse strict UTF-8 JSON. Duplicate keys, invalid Unicode, oversized integers, and nesting beyond 64 levels raise JsonError. It takes `input` as a string. Failures can raise `JsonError`.
+
+Within an unsafe block, it returns [`_aug_json_parse`](contracts.md#symbol-_aug_json_parse) with `input`. Native operations must satisfy their declared C contracts.
+
+### `_aug_json_parse` · [source](contracts.md#code) {#symbol-_aug_json_parse}
+
+It is private to its defining scope. It takes `input` as a string. It returns `Json`. Failures can raise `JsonError`.
+
+Native C implementation; only its declared contract is visible here.
+
+::::
+
+:::::

package/docs/examples/json-benchmark/index.md

@@ -12,22 +12,24 @@ outline: [2, 3]
 
 Parse, decode, and serialize a typed record 5,000 times.
 
-Read a file below to see its highlighted source and the Markdown produced by `aug spec`. Choose **Indentation** or **Braces** above the code. Both views describe the same checked program; your choice is kept when you open another file.
+Open a file to read its source beside the explanation produced by `aug spec`. **Indentation** and **Braces** display the same checked program; your choice carries across file pages.
 
 ## Project files
 
 - [`main.aug`](main.md)
 - [`data.aug`](data.md)
 
+- [`main.yaml`](main-yaml.md)
 
 ## Try this project
 
-From a repository checkout with August installed:
+[Download this project](/downloads/json-benchmark.zip), then extract the archive in an empty working folder. It contains the checked source, configuration, and generated specs. [Install August](../../getting-started.md) once, then run these commands. Native libraries are prepared automatically when needed:
 
 ```sh
-aug check benchmarks/json
-aug spec benchmarks/json
-aug run benchmarks/json
+cd json-benchmark
+aug check .
+aug spec .
+aug run .
 ```
 
 See [the performance page](../../performance.md) for measurements, input sizes, and reproduction steps.

package/docs/examples/json-benchmark/main-yaml.md

@@ -0,0 +1,20 @@
+---
+title: "main.yaml · JSON benchmark"
+generated: true
+source: "benchmarks/json/main.yaml"
+editLink: false
+prev: false
+next: false
+outline: [2, 3]
+---
+
+# `main.yaml`
+
+[JSON benchmark](index.md) · Project configuration
+
+```yaml
+
+
+packages:
+  json: "https://github.com/GreenPandaStudios/augscript/src/stdlib/json#v0.19.0"
+```