Repository navigation
docs: add AGENTS.md engineering protocol and CONTRIBUTING.md - #10
Conversation
Captures the gateway wire-protocol compatibility contract (protocol/ and session/ as the compatibility surface), the dual build targets (app + NullHub module.js), and the validation gates.
DonPrus
left a comment
DonPrus
left a comment
There was a problem hiding this comment.
Reviewed both documents against the implementation, README, package scripts, CI/release workflows, and current main. There are no existing PR discussions to resolve, no duplicate contributor guide, and no merge conflict. The protocol/session compatibility boundary and both build targets are correctly identified; CI runs the documented checks and builds both release bundles.
One non-blocking wording improvement: it would be great to replace “pairing tokens are ephemeral client-side state” with the actual storage contract. src/lib/session/auth-storage.ts persists the access token and shared key in localStorage with an expiry (default 86,400 seconds), and README documents session restoration. Calling them ephemeral may lead future changes to assume they only live in memory. “Keep tokens and keys out of logs; persisted browser auth must respect its TTL and be cleared on rejection” would match the implementation. Similarly, the exact cipher name is ChaCha20-Poly1305.
Approved: this is documentation-only with no blocking issue. Validation was source/documentation comparison and a clean merge-tree check; I did not rerun the application suite for these text additions.
…ract (DonPrus review)
|
Addressed both points in 5934c52:
Documentation-only, pure addition to two new files. CI running; approval retained. |
NullClaw Chat UI had neither an AGENTS.md nor a CONTRIBUTING.md. Added both: the gateway wire-protocol compatibility contract (protocol/ and session/ directories), the dual build targets (web app + NullHub module.js), and validation gates (vitest, svelte-check, both builds). Docs-only.