docs: align SDKs and docs with single-port model#9
Merged
Conversation
Follow-up to the device/client server merge (#8). No behavior change — comments, type docs, guide prose, and test-client labels only. - nfc-client SDK: fix stale example port (18080 -> 9470) and note it connects to the shared agent port via plain /ws. - nfc-device SDK: note it connects via /ws?mode=device on the same shared port; reword "Device Server" -> "NFC Agent". - docs/api.md, docs/javascript-client.md, README.md: rename the "Device Server"/"Client Server" role wording to device/client endpoints of the single agent; update the section anchors and the links that point at them. - test-client.html: relabel the two URL fields as "Agent URL (client)" and "Agent URL (device)". Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_019UWqA9fEkcZQyEk9qujEqK
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #8 (the device/client server merge onto a single port). Documentation, comments, and UI labels only — no behavior change, no
.gochanges.The merge left the SDKs functionally correct (they're URL-parameterized, and the device client already targets the shared port via
?mode=device), but the surrounding docs still described two separate servers and carried a stale example port. This aligns the wording with the single-port model.Changes
SDKs (comments / type docs only)
nfc-client.js/nfc-client.d.ts: fix the stale example port (18080→9470) and add a header note that it connects to the shared agent port via plain/ws.nfc-device-client.js/nfc-device-client.d.ts: add a matching note that it connects via/ws?mode=deviceon the same shared port; reword "Device Server" → "NFC Agent".Docs
docs/api.md:## Device Server API→## Device API; prose → "device endpoint" / "the agent" (also fixes the prior inconsistency with the already-renamed "Client API").docs/javascript-client.md:## NFCClient (Client Server)→(client role); "Device Server" → "agent" in body text.README.md: update the two "Device Server" mentions and the cross-links to the renamed anchors.client/test-client.html: relabel the URL fields "Agent URL (client)" / "Agent URL (device)".Notes
9471references remain (CHANGELOG history aside).govulncheckfinding GO-2026-5026 ingolang.org/x/net, whose fix requires a Go 1.25 bump + CI linter upgrade.🤖 Generated with Claude Code
Generated by Claude Code