Skip to content

Commit 8a1e195

Browse files
authored
docs: trim stale internal docs (#498)
1 parent af5db7f commit 8a1e195

7 files changed

Lines changed: 14 additions & 339 deletions

File tree

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ Command-only flags (like `find --first`) that don't flow to the platform layer o
194194
- Do not update `skills/**/SKILL.md` for command behavior or workflow guidance unless the user explicitly asks; skills must route to versioned CLI help instead of carrying behavior details.
195195
- Keep SkillGym cases behavioral and command-planning oriented. Prefer prompts that assert the user-visible contract and expected command family over brittle exact output, but forbid known bad patterns.
196196
- Build before SkillGym when local CLI help is needed: `pnpm build`, then `pnpm exec skillgym run ... --case <id>`.
197-
- Run SkillGym broad validation with `pnpm test:skillgym`; use v0.6 `--tag` filters for focused suite groups.
197+
- Run SkillGym broad validation with `pnpm test:skillgym`; use v0.8 `--tag` filters for focused suite groups.
198198
- Preserve current high-value workflow guidance:
199199
- iOS Expo Go dogfood: prefer `agent-device open "Expo Go" <url> --platform ios` when the shell is known, then `snapshot -i` to confirm the project UI rather than the runner splash.
200200
- `keyboard dismiss` is the preferred iOS keyboard-dismissal path before manually pressing visible keyboard controls such as `Done`; it remains best-effort and can report unsupported layouts explicitly.

COMMAND_OWNERSHIP.md

Lines changed: 0 additions & 198 deletions
This file was deleted.

android-snapshot-helper/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ requires a stable signing certificate for `adb install -r` upgrades.
1414
## Build
1515

1616
```sh
17-
sh ./scripts/build-android-snapshot-helper.sh 0.13.3 .tmp/android-snapshot-helper
17+
VERSION="$(node -p 'require("./package.json").version')"
18+
sh ./scripts/build-android-snapshot-helper.sh "$VERSION" .tmp/android-snapshot-helper
1819
```
1920

2021
The build uses Android SDK command-line tools directly. It expects `ANDROID_HOME` or
@@ -26,7 +27,8 @@ missing or outdated.
2627
## Run
2728

2829
```sh
29-
adb install -r -t .tmp/android-snapshot-helper/agent-device-android-snapshot-helper-0.13.3.apk
30+
VERSION="$(node -p 'require("./package.json").version')"
31+
adb install -r -t ".tmp/android-snapshot-helper/agent-device-android-snapshot-helper-$VERSION.apk"
3032
adb shell am instrument -w \
3133
-e waitForIdleTimeoutMs 500 \
3234
-e timeoutMs 8000 \

skills/react-devtools/SKILL.md

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -19,30 +19,6 @@ Read current CLI guidance:
1919
agent-device help react-devtools
2020
```
2121

22-
Use `agent-device react-devtools ...` for component tree, props, state, hooks, render ownership, performance profiling, slow components, or rerenders. It dynamically runs pinned `agent-react-devtools@0.4.0`. Use normal `agent-device` commands for visible UI, refs, screenshots, logs, network, or device-level perf.
22+
Use `agent-device react-devtools ...` for component tree, props, state, hooks, render ownership, performance profiling, slow components, or rerenders. Use normal `agent-device` commands for visible UI, refs, screenshots, logs, network, or device-level perf.
2323

24-
Core loop:
25-
26-
```bash
27-
agent-device react-devtools status
28-
agent-device react-devtools wait --connected
29-
agent-device react-devtools get tree --depth 3
30-
agent-device react-devtools profile start
31-
# perform the interaction with normal agent-device commands
32-
agent-device react-devtools profile stop
33-
agent-device react-devtools profile slow --limit 5
34-
agent-device react-devtools profile rerenders --limit 5
35-
```
36-
37-
Remote iOS bridge order:
38-
39-
```bash
40-
agent-device open <bundle-id> --platform ios --relaunch
41-
agent-device react-devtools start
42-
agent-device open <bundle-id> --platform ios --relaunch
43-
agent-device react-devtools wait --connected
44-
```
45-
46-
Rules:
47-
48-
Keep reads bounded with `--depth`/`find`, treat `@c` refs as reload-local, profile only the investigated interaction, and run the same command in remote Android sessions; the CLI manages the needed local service tunnel. For remote iOS, relaunch after `react-devtools start` because React Native opens the legacy DevTools websocket during JavaScript startup.
24+
Keep reads bounded with `--depth`/`find`, treat `@c` refs as reload-local, and profile only the investigated interaction. Let `help react-devtools` provide exact command shapes, remote bridge ordering, pinned package details, and current workflow guidance.

src/__tests__/cli-react-devtools.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ test('react-devtools passthrough pins agent-react-devtools package version', ()
5959
});
6060

6161
test('react-devtools docs mention the pinned package version', () => {
62-
const docs = ['website/docs/docs/commands.md', 'skills/react-devtools/SKILL.md'];
62+
const docs = ['website/docs/docs/commands.md'];
6363

6464
for (const file of docs) {
6565
assert.match(fs.readFileSync(file, 'utf8'), new RegExp(AGENT_REACT_DEVTOOLS_PACKAGE));

src/platforms/SNAPSHOT_CONTRACT.md

Lines changed: 0 additions & 109 deletions
This file was deleted.

website/docs/docs/client-api.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,9 +131,13 @@ import {
131131
prepareAndroidSnapshotHelperArtifactFromManifestUrl,
132132
} from 'agent-device/android-snapshot-helper';
133133

134+
const helperVersion = '<agent-device version>';
135+
const manifestUrl =
136+
`https://github.com/callstackincubator/agent-device/releases/download/v${helperVersion}/` +
137+
`agent-device-android-snapshot-helper-${helperVersion}.manifest.json`;
138+
134139
const artifact = await prepareAndroidSnapshotHelperArtifactFromManifestUrl({
135-
manifestUrl:
136-
'https://github.com/callstackincubator/agent-device/releases/download/v0.13.3/agent-device-android-snapshot-helper-0.13.3.manifest.json',
140+
manifestUrl,
137141
});
138142

139143
await ensureAndroidSnapshotHelper({

0 commit comments

Comments
 (0)