Skip to content

Documentation gaps identified by AI Evaluation — June 2025 #61

@Freddyminu

Description

@Freddyminu

Overview

The following documentation gaps were identified by our AI Evaluation based on questions asked to the AI assistant over the last month. These are cases where the bot responded with variations of "the documentation doesn't cover this."

Gaps to address

  • Indoor widget configuration — Users had long iterative sessions unable to figure out what device payload format the Indoor widget expects, or what to put in "variable used to store layers" and "geofence variable". The Image Marker documentation has no reference to Indoor tracking (making it hard for the AI to find), and even when found, those fields are not explained.

  • Cache management — A developer asked specifically for a "cache flush capability" and visibility into cache state. The bot confirmed this is not documented.

  • Bulk alert creation — Flagged as undocumented.

  • Entity table indexes via API — Flagged as undocumented.

  • Changing a device's serial number using the API — Flagged as undocumented.

  • "Filter using ID(s) is not supported on Immutable Storage Type" — A real error message users hit in the Compose widget that has no troubleshooting page.

Source

Reported by Vitor based on AI Evaluation results from the past month.

Metadata

Metadata

Assignees

No one assigned

    Labels

    new pageImprovements or additions to documentation

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions