Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions site/src/content/docs/ports/ocaml/examples/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ cards:
- label: Workspaces
href: ../workspace/source-guide/
body: Validate, plan and apply a complete JSON workspace.
- label: Interrupted workspace
href: ../workspace/recovery/
body: Cancel an Eio waiter, inspect its journal and check the created session.
---

Start with the [graph program](../guides/getting-started/), then run the
Expand Down
5 changes: 5 additions & 0 deletions site/src/content/docs/ports/ocaml/workspace/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ cards:
- label: Workspace guide
href: ./source-guide/
body: Validate, plan and apply JSON configuration, then inspect its receipt.
- label: Interrupted execution
href: ./recovery/
body: Retain the journal, inspect partial effects and check compensation.
- label: API reference
href: ./reference/
body: Browse pure validation and planning alongside explicit execution.
Expand All @@ -21,6 +24,8 @@ cards:
Install `libtmux-workspace-cli` from the source checkout to run `tmux-workspace`.
The CLI uses the JSON decoder, pure workspace plan and native client packages.
It retains a receipt for recovery after partial or uncertain execution.
The journal lives in process memory; it does not resume a later CLI invocation.

[Run a complete workspace](../workspace/source-guide/) ·
[Inspect an interrupted workspace](./recovery/) ·
[Workspace API](../workspace/reference/)
2 changes: 1 addition & 1 deletion site/src/data/api/ocaml.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion site/src/data/api/ocaml.paths.json

Large diffs are not rendered by default.

20 changes: 10 additions & 10 deletions site/src/data/example-sources.json

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions site/src/data/manifest-packages.json
Original file line number Diff line number Diff line change
Expand Up @@ -911,43 +911,43 @@
},
"ocaml": {
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605",
"revision": "205dfda49742592b479247049d186956e4a4cfe9",
"distributions": [
{
"name": "libtmux",
"manifest": "libtmux.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
},
{
"name": "libtmux-eio",
"manifest": "libtmux-eio.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
},
{
"name": "libtmux-json",
"manifest": "libtmux-json.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
},
{
"name": "libtmux-unix",
"manifest": "libtmux-unix.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
},
{
"name": "libtmux-workspace",
"manifest": "libtmux-workspace.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
},
{
"name": "libtmux-workspace-cli",
"manifest": "libtmux-workspace-cli.opam",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605"
"revision": "205dfda49742592b479247049d186956e4a4cfe9"
}
],
"units": []
Expand Down
7 changes: 7 additions & 0 deletions site/src/data/mentions.json
Original file line number Diff line number Diff line change
Expand Up @@ -11053,6 +11053,13 @@
"title": "Choose the packages your application needs",
"section": "guides"
},
{
"port": "ocaml",
"symbol": "Libtmux_eio.Workspace.inspect",
"page": "/ocaml/latest/workspace/recovery/",
"title": "Interrupt a workspace and inspect its journal",
"section": "workspace"
},
{
"port": "ocaml",
"symbol": "Libtmux_json",
Expand Down
12 changes: 8 additions & 4 deletions site/src/data/port-guides/ocaml.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion site/src/data/tmux-usage/ocaml.json
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@
],
"port": "ocaml",
"repo": "libtmux/libtmux-ocaml",
"revision": "6b814a3ae27b6a700b5d45ff1ef654565a1f1605",
"revision": "205dfda49742592b479247049d186956e4a4cfe9",
"schemaVersion": 1,
"symbols": {
"Libtmux_eio.Client.break_pane": [
Expand Down
1 change: 1 addition & 0 deletions site/src/lib/port-documentation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,7 @@ const PORT_DOCUMENTATION: Readonly<Record<string, PortDocumentation>> = {
...['getting-started', 'bootstrap', 'graph', 'queries', 'query-interchange', 'control', 'recovery', 'streaming', 'showcases', 'packages', 'compatibility', 'testing', 'benchmarking', 'status'].map((name, index) =>
guide(`docs/${name}.md`, `guides/${name}`, 'core', { aliases: [], sidebar: { group: 'Guides', order: index + 1 } })),
guide('docs/workspaces.md', 'workspace/source-guide', 'workspace', { title: 'Workspace guide', product: 'workspace', package: 'workspace', aliases: [] }),
guide('docs/workspace-recovery.md', 'workspace/recovery', 'workspace', { title: 'Interrupt a workspace and inspect its journal', product: 'workspace', package: 'workspace', aliases: [] }),
],
redirects: [{ sourcePath: 'docs/api.md', path: 'guides/api', target: 'reference' }],
},
Expand Down
Loading