mirror of
https://github.com/priyanshujain/sanderling.git
synced 2026-10-02 19:17:10 +00:00
docs update with case study (#63)
* docs(manual): add introduction page * docs(manual): rewrite getting started as guided first run * docs(manual): rewrite writing specs as a folio tutorial * docs(manual): document missing spec API in reference * docs(manual): plain-language rewrite of runs page * docs: real introductions on index pages and README * fix(docs): sibling links from directory-style pages need ../ * fix(docs): correct sampling and restart-cost claims to match implementation * docs: nav lists Introduction and Case study; roadmap points to milestone * docs(manual): make getting started target the reader's own app, not Folio * docs(manual): add Folio case study page * docs: point manual navigation at the case study * docs(readme): lead with the case study, fix roadmap link * docs: roadmap links to milestone, sync clear-data default and cross-links
This commit is contained in:
13 files changed
+396
-424
No files matched your search
+2
-2
@@ -36,7 +36,7 @@ Serve a local web UI for browsing traces. The positional argument is optional an
|
||||
| `--no-open` | `false` | Skip opening the default browser on startup. |
|
||||
| `--dev` | `false` | Reverse-proxy non-API requests to the Vite dev server on `127.0.0.1:5173`. |
|
||||
|
||||
See [the replay UI page](./replay/) for the panel reference and keyboard shortcuts.
|
||||
See [the replay UI page](../replay/) for the panel reference and keyboard shortcuts.
|
||||
|
||||
## `sanderling doctor`
|
||||
|
||||
@@ -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).
|
||||
Reference in new issue
Block a user