Skip to content

docs: correct inaccuracies across guides, references, and tutorials - #13

Open
sedawwk wants to merge 1 commit into
masterfrom
docs/accuracy-fixes
Open

docs: correct inaccuracies across guides, references, and tutorials#13
sedawwk wants to merge 1 commit into
masterfrom
docs/accuracy-fixes

Conversation

@sedawwk

@sedawwk sedawwk commented Aug 7, 2026

Copy link
Copy Markdown
Collaborator

Fix factual errors in docs-site based on actual SDK behavior:

  • faq: RTC TCP client needs agent_token at connect; remove stale CONNECTION_REFRESH auto-refresh claim
  • dp-persistence: note that dump/restore omits RAW DPs; schema_id is immutable so no rewrite needed on schema update
  • ota-upgrade: report success before reboot; add esp_crt_bundle include, cert_bundle_attach field, and required iot_init() call
  • porting-to-new-platform: correct PAL_FR_TASK_STACK_WORDS size (6144 words ~= 24KB on 32-bit)
  • vad-and-interrupt: replace session_attrs_json with event_user_data_json/chatAttributes; document default VAD=true
  • iot-client: expand iot_client_process/publish return values (OPRT_INVALID_PARAMETER, OPRT_UNINITIALIZED, etc.)
  • openapi-activate: note pairing-result --poll for token verification
  • pair-by-ble: tuya_ble_nimble_stop() always returns 0

Fix factual errors in docs-site based on actual SDK behavior:

- faq: RTC TCP client needs agent_token at connect; remove stale
  CONNECTION_REFRESH auto-refresh claim
- dp-persistence: note that dump/restore omits RAW DPs; schema_id
  is immutable so no rewrite needed on schema update
- ota-upgrade: report success before reboot; add esp_crt_bundle
  include, cert_bundle_attach field, and required iot_init() call
- porting-to-new-platform: correct PAL_FR_TASK_STACK_WORDS size
  (6144 words ~= 24KB on 32-bit)
- vad-and-interrupt: replace session_attrs_json with
  event_user_data_json/chatAttributes; document default VAD=true
- iot-client: expand iot_client_process/publish return values
  (OPRT_INVALID_PARAMETER, OPRT_UNINITIALIZED, etc.)
- openapi-activate: note pairing-result --poll for token verification
- pair-by-ble: tuya_ble_nimble_stop() always returns 0
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