docs: fix AimX v1/v2 rot, dead spec links, and removed-API references#145
Open
lxsaah wants to merge 1 commit into
Open
docs: fix AimX v1/v2 rot, dead spec links, and removed-API references#145lxsaah wants to merge 1 commit into
lxsaah wants to merge 1 commit into
Conversation
Doc-rot fixes from the post-036 debt scan; no wire or API behavior changes (the one wire-visible byte change — the client hello version — is corrected from a stale "1.0" to the "2.0" the server already announces; the server never validates it). - remote::PROTOCOL_VERSION corrected to "2.0", documented, and exported; the AimX dispatch Welcome and aimdb-client both use it now, so client and server can no longer drift. The dead, never-exported v1 untagged Message envelope and its helpers are deleted. - remote module docs: "AimX v1" + link to the nonexistent docs/design/remote-access/aimx-v1.md replaced with the v2 NDJSON tagged-frame description pointing at session::aimx and remote-access-via-connectors.md; stale .build()? example fixed to the (db, runner) = build().await? shape. - connector module docs: removed-`.link()` API replaced with the real configure/link_to pattern (the old example used a RecordConfig::builder API that never existed); ConnectorUrl no longer advertises Kafka/HTTP connector semantics for connectors that don't exist — documented as scheme-agnostic with real schemes (mqtt, knx, ws, uds, serial). - builder.rs AimDb example fixed: register_record returns &mut Self, so the old chained .build() could not compile. - aimdb-client README rewritten to match reality (AimxConnection, v2 wire, endpoint URLs incl. serial); crate doc + aimdb-cli doc updated. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This was referenced Jun 12, 2026
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
1 participant
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
Doc-rot fixes surfaced by a fresh technical-debt scan after the 034→036 refactor cycle. Stacked on #144 (retarget to main as the stack merges). No wire or API behavior changes — the one wire-visible byte change is the client hello version, corrected from a stale
"1.0"to the"2.0"the server already announces (the server never validates it).AimX v1/v2 identity rot
remote::PROTOCOL_VERSIONcorrected to"2.0", documented, and exported; the AimX dispatchWelcome(was a hardcoded"2.0") andaimdb-client(was a stale local"1.0") both consume it now, so client and server can no longer drift.Messageenvelope + helpers fromremote::protocol(v2 uses tagged frames insession::aimx; this had zero users).remotemodule docs: "AimX v1" and the link to the nonexistentdocs/design/remote-access/aimx-v1.mdreplaced with the v2 NDJSON tagged-frame description, pointing atsession::aimxanddocs/design/remote-access-via-connectors.md. Same fix inremote::protocolandaimdb-cliheaders.aimdb-clientREADME rewritten to match reality:AimxConnection(not the retiredAimxClient), v2 framing, runtime-selected transports via endpoint URLs (UDS + serial).Removed-API references (034 §3.6 leftovers)
connectormodule docs referenced the removed.link()API and an example built onRecordConfig::builder()— an API that never existed. Replaced with the realconfigure/link_topattern.ConnectorUrldocs no longer advertise Kafka/HTTP connector semantics for connectors that don't exist; documented as scheme-agnostic with the schemes actually in-tree (mqtt, knx, ws, uds, serial). Parser code untouched.Stale doc examples
builder.rsAimDbexample couldn't compile as written (register_recordreturns&mut Self, so chaining.build()by value is impossible); fixed to the canonicallet (db, runner) = builder.build().await?shape. Same fix for theremotemodule example (.build()?→.await?+ tuple).Validation
make fmt-check✅make clippy(all feature combos,-D warnings) ✅cargo test -p aimdb-core -p aimdb-client -p aimdb-cli -p aimdb-mcp✅, plusaimdb-core --no-default-features✅cargo check --workspaceagainst this branch ✅🤖 Generated with Claude Code