Skip to content

Bring the user documents in line with the code - #443

Merged
jeff377 merged 2 commits into
mainfrom
claude/p3-user-docs
Nov 12, 2026
Merged

jeff377 merged 2 commits into
mainfrom
claude/p3-user-docs

Conversation

@jeff377

@jeff377 jeff377 commented Nov 12, 2026

Copy link
Copy Markdown
Contributor

Part of #441

Documentation only (docs/en and its docs/zh-TW translation, restamped). Each statement was checked against the code; an adversarial review then compared every changed sentence with the source.

  • Error contract: a rejected API key or malformed Authorization header answers HTTP 200 with -32600, not 401 (frontend integration, its TypeScript wrapper comment, cookbook, platform support). By default only a non-JSON body (415), a too-large body (413) and a notification-only message (204) get another status; a host can change that with JsonRpcHttpOptions.StatusCodeSelector, which Polhem does not set.
  • Wire formats: Blazor WASM and the Avalonia browser head send Encoded payloads, not encrypted ones; Blazor Server can be Local or Remote.
  • UI packages: the cookbook's decision tree, its note and its quick reference, and the terminology page, now list Mud and Fluent and the Server and WebAssembly hosts; AddPolhemBlazor is defined by each host.
  • Removed things no longer named: the samples' Staff form and DEMO company, polhem-dynamic-form/-grid (now polhem-form-layout/polhem-grid), DynamicGrid.EmptyText, ApiConnector.FinalizeResponse.
  • Described as they are: FieldValueChange among the Plain-callable Form methods; BusinessResultResponsePairingTests covering the framework's own result types; the plugin binding check (exactly the declared stage); a missing st_api_key table letting calls through; BlazorUserContext in Polhem.Web.Blazor, used by both hosts; FormLiveComputation in both UI layers; IDbAccessFactory never for company tables; the CI AOT gate's project list now points to build-ci.yml instead of copying it.
  • 1.13.0 notes: the wire statement now says MessagePack is unchanged while the JSON body codec carries DateTime as a UTC instant.

The dependency map items (B-07 to B-09) are left for the dependency map batch, which also makes check-dependency-map.sh check its package table.

Verified locally: check-docs-i18n.sh, check-public-docs.sh, check-md-links.sh, check-xmldoc-refs.sh, check-dependency-map.sh. Lite CI.

A rejected API key or Authorization header answers HTTP 200 with -32600, not 401; Blazor WASM sends Encoded payloads, not encrypted ones; the UI package lists include Fluent and the WebAssembly host; removed samples, CSS classes and members are no longer named; the FieldValueChange method, the plugin binding check, the missing st_api_key table, the client-side error rebuild and BlazorUserContext's package are described as they are; the 1.13.0 notes say the JSON body codec now carries DateTime as a UTC instant.
…ass mapping

Review follow-up: the Avalonia browser head sends Encoded payloads like Blazor WASM; bee-dynamic-form and bee-dynamic-grid map to polhem-form-layout and polhem-grid; the HTTP status statement is the default unless the host sets StatusCodeSelector, and a notification-only message gets 204.
@jeff377
jeff377 enabled auto-merge (squash) November 12, 2026 12:40
@jeff377
jeff377 merged commit 1e983a6 into main Nov 12, 2026
3 checks passed
@jeff377
jeff377 deleted the claude/p3-user-docs branch November 12, 2026 12:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant