Skip to content

Commit e308d5b

Browse files
authored
Merge pull request #1 from NodeOps-app/docs/dedupe-parity-protocol
docs: drop the hand-written cross-SDK parity protocol
1 parent 008c486 commit e308d5b

2 files changed

Lines changed: 2 additions & 38 deletions

File tree

‎CLAUDE.md‎

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -57,39 +57,3 @@ HTTP endpoint or method · wire or JSON field · error shape · sandbox lifecycl
5757
5. **Report, don't edit.** This is a read-and-report protocol: do not change a sibling repo unless the user asks you to.
5858

5959
<!-- MESH:END -->
60-
61-
## Cross-SDK parity protocol
62-
63-
Run this before you call any change to this repo done. It is a read-and-report
64-
protocol — **do not edit a sibling repository unless the user asks you to.**
65-
66-
1. **Classify the change.**
67-
- *Wire contract* (new endpoint, changed field, new request/response shape)
68-
→ affects all three SDKs and usually the docs.
69-
- *Behaviour* (retry policy, timeout default, stream framing, error
70-
mapping) → affects all three SDKs.
71-
- *Bug fix* → check whether the siblings have the same bug. They were
72-
written from the same spec, so they usually do.
73-
- *Ergonomics* (a Pythonic helper, a context manager) → often has a natural
74-
equivalent in the siblings; propose it, don't assume it.
75-
- *Repo-local* (packaging, lint config, CI) → no parity obligation.
76-
2. **Check the siblings.** Read the matching file under `../fc-sdk/src/` and
77-
`../createos-go-sdk/sandbox/`. If a sibling checkout is missing, say so
78-
rather than guessing.
79-
3. **Report.** End the task with a short parity note: what ports to which SDK,
80-
what does not, and why. Name the file the sibling change would land in.
81-
4. **Docs.** If the change adds or alters a user-visible capability, say
82-
whether `SDK/Overview.mdx` and the affected page under
83-
`apps/docs/src/pages/Sandbox/` need updating.
84-
85-
The same protocol runs in reverse: when the TypeScript or Go SDK gains a
86-
feature or fix, check whether it belongs here.
87-
88-
### Current parity baseline
89-
90-
The Python and Go SDKs expose the same surface and ship the same nine examples
91-
(`hello_world`, `command_streaming`, `files_and_snapshots`, `ingress_preview`,
92-
`managed_process`, `network`, `custom_template`, `desktop`,
93-
`execution_server`). The TypeScript SDK has the same core surface plus a much
94-
larger integration-example corpus. Treat a gap against Go as a real gap; treat
95-
a gap against a TypeScript *integration example* as optional.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,8 +69,8 @@ As an alternative, `Client()` reads `CREATEOS_SANDBOX_API_KEY` and
6969
- [CreateOS TypeScript SDK](https://github.com/NodeOps-app/createos-sandbox-sdk)
7070
provides the same sandbox capabilities for JavaScript and TypeScript
7171
applications.
72-
- [`CLAUDE.md`](CLAUDE.md) is the agent guide: repository conventions, the map
73-
of sibling SDKs and their agent guides, and the cross-SDK parity protocol.
72+
- [`CLAUDE.md`](CLAUDE.md) is the agent guide: repository conventions plus the
73+
generated cross-repo mesh block.
7474
- [Runnable examples](#examples) demonstrate complete SDK workflows.
7575
- The public Python API is typed and documented with Python docstrings.
7676
- [Contributing guide](CONTRIBUTING.md) documents development checks and commit

0 commit comments

Comments
 (0)