Skip to content

Commit 748eab6

Browse files
committed
docs(release): align entry path with public shell
1 parent c36bc43 commit 748eab6

5 files changed

Lines changed: 83 additions & 44 deletions

docs/releases/2026-03-14-first-usable-version-acceptance-checklist.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ Use this checklist before sharing the current install-demo baseline as the **fir
44

55
- [ ] Default install path stays `openclaw plugins install .\plugins\openclaw-clawguard`
66
- [ ] Optional tarball path stays local-only and unpublished
7-
- [ ] Smoke path works on `/plugins/clawguard/dashboard`, `/plugins/clawguard/checkup`, `/plugins/clawguard/approvals`, `/plugins/clawguard/audit`, and `/plugins/clawguard/settings`, with repeatable HTTP-level regression coverage on the plugin-owned direct-route surface
7+
- [ ] Browser-facing smoke path works on `/clawguard`, `/clawguard/checkup`, `/clawguard/approvals`, `/clawguard/audit`, and `/clawguard/settings`
8+
- [ ] Protected backing routes remain available under `/plugins/clawguard/*` for the public shell and regression coverage
89
- [ ] Demo order stays fake-only across `exec`, outbound, and workspace mutation examples
910
- [ ] Public wording says **install-demo only / unpublished / fake-only**
1011
- [ ] Public wording does **not** claim GA, registry publish, real outbound proof, real money movement, or broad workspace coverage

docs/releases/2026-03-14-first-usable-version-announcement-draft.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ What you can do today:
1313
1. Install locally from the repo root with `openclaw plugins install .\plugins\openclaw-clawguard`
1414
2. Restart OpenClaw
1515
3. Open:
16-
- `/plugins/clawguard/dashboard`
17-
- `/plugins/clawguard/checkup`
18-
- `/plugins/clawguard/approvals`
19-
- `/plugins/clawguard/audit`
20-
- `/plugins/clawguard/settings`
16+
- `/clawguard`
17+
- `/clawguard/checkup`
18+
- `/clawguard/approvals`
19+
- `/clawguard/audit`
20+
- `/clawguard/settings`
2121
4. Walk through a narrow fake-only demo across risky `exec`, minimal outbound review points where host-level direct sends stay on the hard-block path, and workspace mutation actions currently limited to `write` / `edit` / `apply_patch`
2222

2323
What this proves:

docs/releases/2026-03-14-first-usable-version-release-note-internal-draft.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ It does **not** broaden runtime scope. It packages the current codebase and unre
1414

1515
### Runtime / operator surface
1616

17-
- OpenClaw native plugin install from local repo path
18-
- Optional local tarball path for demo packaging only
19-
- Plugin-owned pages:
20-
- `/plugins/clawguard/dashboard`
21-
- `/plugins/clawguard/checkup`
22-
- `/plugins/clawguard/approvals`
23-
- `/plugins/clawguard/audit`
24-
- `/plugins/clawguard/settings`
17+
- OpenClaw native plugin install from local repo path
18+
- Optional local tarball path for demo packaging only
19+
- Plugin-owned public shell browser path:
20+
- `/clawguard`
21+
- `/clawguard/checkup`
22+
- `/clawguard/approvals`
23+
- `/clawguard/audit`
24+
- `/clawguard/settings`
25+
- Protected backing routes remain under `/plugins/clawguard/*`
2526
- Pending-action + allow-once-retry approval loop
2627
- Audit closure for the current demo flows
2728

@@ -56,12 +57,13 @@ It does **not** broaden runtime scope. It packages the current codebase and unre
5657

5758
### Smoke
5859

59-
1. Restart OpenClaw
60-
2. Open `/plugins/clawguard/dashboard`
61-
3. Open `/plugins/clawguard/checkup`
62-
4. Open `/plugins/clawguard/approvals`
63-
5. Open `/plugins/clawguard/audit`
64-
6. Open `/plugins/clawguard/settings`
60+
1. Restart OpenClaw
61+
2. Run `openclaw dashboard --no-open`
62+
3. Replace the official tokenized dashboard URL path with `/clawguard`
63+
4. Open `/clawguard/checkup`
64+
5. Open `/clawguard/approvals`
65+
6. Open `/clawguard/audit`
66+
7. Open `/clawguard/settings`
6567

6668
### Demo order
6769

@@ -75,7 +77,7 @@ It does **not** broaden runtime scope. It packages the current codebase and unre
7577
## What this version proves
7678

7779
- We have a repeatable local install story for the OpenClaw plugin baseline
78-
- We have a stable operator smoke path on plugin-owned routes
80+
- We have a stable operator smoke path on the plugin-owned public shell surface, backed by protected plugin routes
7981
- We can explain the current approval / audit loop without implying nonexistent resume or embedded Control UI features
8082
- We can truthfully describe the current scope without implying publish, GA, or broad runtime completeness
8183
- Current local validation baseline remains:
@@ -100,7 +102,7 @@ It does **not** broaden runtime scope. It packages the current codebase and unre
100102
- Say **fake-only** whenever demo scenarios are mentioned
101103
- Say **minimal outbound review points**, not host-level approvals or complete outbound lifecycle
102104
- Say **workspace mutation demo surface currently means `write` / `edit` / `apply_patch`**, not broad workspace governance
103-
- Say **direct plugin routes**, not embedded Control UI
105+
- Say **public shell entry path `/clawguard*` backed by protected plugin routes**, not embedded Control UI
104106

105107
## Validation
106108

docs/releases/2026-03-14-first-usable-version-release-note-public-draft.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,39 +8,44 @@
88

99
This first usable version is a **small, local OpenClaw install demo package**.
1010

11-
It gives new users one honest path to try ClawGuard today:
12-
13-
- install the plugin locally,
14-
- restart OpenClaw,
15-
- open the plugin-owned dashboard / checkup / approvals / audit / settings pages,
16-
- and walk through a few **fake-only** approval and audit scenarios.
11+
It gives new users one honest path to try ClawGuard today:
12+
13+
- install the plugin locally,
14+
- restart OpenClaw,
15+
- open the plugin-owned public shell entry and move through dashboard / checkup / approvals / audit / settings,
16+
- and walk through a few **fake-only** approval and audit scenarios.
1717

1818
## What users can do today
1919

2020
- Install from the repo root with:
2121
- `openclaw plugins install .\plugins\openclaw-clawguard`
22-
- Optionally build one **local-only** tarball for demo packaging:
23-
- `pnpm --dir plugins\openclaw-clawguard pack`
24-
- Restart OpenClaw and smoke:
25-
- `/plugins/clawguard/dashboard`
26-
- `/plugins/clawguard/checkup`
27-
- `/plugins/clawguard/approvals`
28-
- `/plugins/clawguard/audit`
29-
- `/plugins/clawguard/settings`
22+
- Optionally build one **local-only** tarball for demo packaging:
23+
- `pnpm --dir plugins\openclaw-clawguard pack`
24+
- Restart OpenClaw and enter through the public shell:
25+
- run `openclaw dashboard --no-open`
26+
- replace the official tokenized dashboard URL path with `/clawguard`
27+
- or open `/clawguard#token=<gateway-token>` directly on the same origin
28+
- Smoke:
29+
- `/clawguard`
30+
- `/clawguard/checkup`
31+
- `/clawguard/approvals`
32+
- `/clawguard/audit`
33+
- `/clawguard/settings`
3034
- Run a narrow demo surface across:
3135
- risky `exec`
3236
- minimal outbound review points, where host-level direct sends stay on the hard-block path and tool-level approvals remain on `message` / `sessions_send`
3337
- workspace mutation actions currently limited to `write` / `edit` / `apply_patch`
3438

3539
## Recommended smoke path
3640

37-
1. Open `/plugins/clawguard/dashboard`
38-
2. Open `/plugins/clawguard/checkup`
39-
3. Open `/plugins/clawguard/approvals`
40-
4. Open `/plugins/clawguard/audit`
41-
5. Open `/plugins/clawguard/settings`
42-
6. Run one fake-only risky `exec` example
43-
7. If needed, add one fake-only outbound example and one fake-only workspace mutation example
41+
1. Run `openclaw dashboard --no-open`
42+
2. Replace the official tokenized dashboard URL path with `/clawguard`
43+
3. Open `/clawguard/checkup`
44+
4. Open `/clawguard/approvals`
45+
5. Open `/clawguard/audit`
46+
6. Open `/clawguard/settings`
47+
7. Run one fake-only risky `exec` example
48+
8. If needed, add one fake-only outbound example and one fake-only workspace mutation example
4449

4550
## Recommended demo order
4651

@@ -64,7 +69,7 @@ It gives new users one honest path to try ClawGuard today:
6469
## What this version proves
6570

6671
- ClawGuard has a **usable local OpenClaw plugin install path**
67-
- The plugin can serve its own operator pages under `/plugins/clawguard/*`
72+
- The plugin can serve its own protected operator pages under `/plugins/clawguard/*`, with `/clawguard*` as the supported browser-facing entry path
6873
- The current approval + audit loop is understandable enough for a first install demo
6974
- The current demo surface can explain a narrow set of fake-only flows across `exec`, outbound, and workspace mutation actions
7075
- The current repository validation baseline is green:
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
type: docs
3+
scope: docs
4+
audience: public
5+
summary: Align release and acceptance drafts to the /clawguard public-shell entry path
6+
breaking: false
7+
demo_ready: true
8+
tests:
9+
- pnpm test -- --run tests/integration/openclaw-clawguard-plugin.test.ts
10+
artifacts:
11+
- docs/releases/2026-03-14-first-usable-version-release-note-public-draft.md
12+
- docs/releases/2026-03-14-first-usable-version-release-note-internal-draft.md
13+
- docs/releases/2026-03-14-first-usable-version-announcement-draft.md
14+
- docs/releases/2026-03-14-first-usable-version-acceptance-checklist.md
15+
---
16+
17+
## What changed
18+
19+
The first-usable-version public draft, internal draft, announcement draft, and acceptance checklist now treat `/clawguard*` as the browser-facing user entry path. They also keep `/plugins/clawguard/*` explicitly framed as protected backing routes rather than the primary user-facing smoke path.
20+
21+
## Why it matters
22+
23+
Recent runtime work made `/clawguard*` the supported no-core-patch browser entry flow. Leaving the older release drafts on raw `/plugins/clawguard/*` wording would keep pointing users at the route family that still returns `401` when opened directly without gateway auth.
24+
25+
Aligning the release docs to the public shell posture keeps the outward story consistent with the actual browser path and with the current security boundary.
26+
27+
## Demo posture / limitations
28+
29+
This does not remove the protected `/plugins/clawguard/*` routes. They remain part of the implementation surface and regression path behind the public shell.
30+
31+
This remains Alpha install-demo only, local-only, unpublished, and fake-only.

0 commit comments

Comments
 (0)