Kindly EditDocumentationTry the editor

Contextual help service

Trace an Ask Kindly request from selected elements to bounded guidance or validated editor actions.

Request boundary#

The help service exposes a health check and a POST ask route. It verifies the product license and active site, applies request and license rate limits, and bounds the request body before processing it. Questions are limited to 2,000 characters and at most five selected elements.

Context is cleaned recursively, limited in depth and collection size, and filtered for keys that resemble passwords, tokens, cookies, authorization, or secrets. This is a defensive boundary, not permission to include credentials in a request. Screenshots must be explicitly attached and satisfy the accepted image format and size.

Selection-aware guidance#

The request carries the selected element's label, structural context, current settings, mode, and bounded site guidance. The service distinguishes Simple and Developer controls. The selected element is the subject of an ambiguous phrase such as “this heading” when the selection already resolves it.

Deterministic text and ordering guides handle supported questions before a model call when applicable. The settings guide maps current values to the actual controls that own them. The knowledge reference supplies documented behavior for other questions.

Proposed actions#

An explicit change request can use the action path. It returns a constrained structured response, which is parsed against the selected references and permitted action schema. The service itself does not write WordPress pages or execute arbitrary page code. The editor validates and applies supported actions through its normal change mechanism.

A response with no valid actions must not claim that the page changed. Garbled responses can be retried within the service's bounded flow. Unsupported changes need an explanation or a supported manual workflow.

Model configuration#

Model choices and fallbacks belong to the independently deployed service configuration. A reviewed model allowlist constrains an override. Model availability can change independently of the WordPress plugin; inspect the deployed service configuration before diagnosing a provider failure.

Files#

  • index.js: request validation, authorization, context assembly, model routing, and responses.
  • act.js: action schema, intent handling, response parsing, and unsupported-change safeguards.
  • settings-guide.js: current panel and style summaries.
  • order-guide.js: collection order and selection summaries.
  • text-guide.js: deterministic text-editing guidance.
  • knowledge.js and knowledge.json: reference lookup and the bundled documentation corpus.

See Ask Kindly for the user-facing workflow.

About this page

Documents Kindly Edit 0.9.16. Source: server/help-worker/index.js, server/help-worker/act.js, server/help-worker/settings-guide.js, assets/context-help.js. Theme choices and account permissions can change which controls appear.

Type a word or phrase to search the full documentation.