diff --git a/docs/development/index.md b/docs/development/index.md index 285a7cd..29f04c2 100644 --- a/docs/development/index.md +++ b/docs/development/index.md @@ -6,7 +6,7 @@ title: Development - [Design principles](./design-principles/) - [Architecture](./architecture/) -- v0.1.0 scope: [issue #4](https://github.com/priyanshujain/sanderling/issues/4) +- v0.1.0 scope: [milestone #1](https://github.com/priyanshujain/sanderling/milestone/1) ## Building the docs site locally diff --git a/docs/manual/cli.md b/docs/manual/cli.md index 6f22de2..ce48e73 100644 --- a/docs/manual/cli.md +++ b/docs/manual/cli.md @@ -65,4 +65,4 @@ Print the CLI version. - `--max-steps` hard cap on step count. - `--exit-on-violation` stop the run on the first property violation. -Tracked in [issue #4](https://github.com/priyanshujain/sanderling/issues/4). +Tracked in the [v0.1.0 milestone](https://github.com/priyanshujain/sanderling/milestone/1). diff --git a/docs/manual/runs.md b/docs/manual/runs.md index c1aaa6a..cec7b05 100644 --- a/docs/manual/runs.md +++ b/docs/manual/runs.md @@ -30,7 +30,7 @@ The trace is written incrementally. An interrupted run is complete up to the ste ## App state across runs -By default the installed app stays in place between runs, so whatever the previous run left behind (an account, cached responses, completed onboarding) carries over. Pass `--clear-data` to wipe app data before launch and start cold every time. See the [CLI reference](../cli/#sanderling-test). +By default each run wipes app data before launch and starts cold. Pass `--clear-data=false` to resume whatever the previous run left behind (an account, cached responses, completed onboarding). See the [CLI reference](../cli/#sanderling-test). ## Why runs are long @@ -44,7 +44,7 @@ Long runs reach states that restart-per-test approaches structurally cannot. ## Setup cost is paid once -Preconditions like login run through the spec's `setup` export (see [writing specs](../writing-specs/#getting-past-login)). They fire when their condition is unmet and go quiet after, so login costs a few seconds once per run, not once per test case. +Preconditions like login run through the spec's `setup` export (see the [case study](../case-study/#reaching-the-screens-that-matter)). They fire when their condition is unmet and go quiet after, so login costs a few seconds once per run, not once per test case. | Run length | Login cost | Share of run | |---|---|---| @@ -63,4 +63,4 @@ A run ends when: - `--duration` elapses, or - the process is interrupted (Ctrl+C). -Additional conditions (`--max-steps`, `--exit-on-violation`, hard crash handling) land in [v0.1.0](https://github.com/priyanshujain/sanderling/issues/4). +Additional conditions (`--max-steps`, `--exit-on-violation`, hard crash handling) land in the [v0.1.0 milestone](https://github.com/priyanshujain/sanderling/milestone/1). diff --git a/docs/manual/spec-language.md b/docs/manual/spec-language.md index 5516ca9..aeff4cc 100644 --- a/docs/manual/spec-language.md +++ b/docs/manual/spec-language.md @@ -4,7 +4,7 @@ title: Spec language reference # Spec language reference -Lookup reference for everything importable from `@sanderling/spec`. For a guided walkthrough, read [writing specs](../writing-specs/) first. +Lookup reference for everything importable from `@sanderling/spec`. For a worked example, read the [case study](../case-study/) first. ## Module structure