Claron
    Documentation
    ANNOTATIONSReviewed

    Annotations

    An annotation is a precise, in-context bug report attached to a specific element, region, console error, or network failure in your live preview.

    Choose the right report type

    1. Start a review session or an authorized extension review.

    2. Choose the annotation tool, select the point/element or diagnostic entry, and enter a clear title.

    3. Describe what happened, what should happen, and the steps that led to it

      Set severity, assignee, and other fields you are permitted to change.

    4. Choose public or internal visibility where your role permits it, submit, and open the saved report to confirm its page/version and evidence.

    TypeUse it for
    PointA problem at a position on the page, without attaching the report to a specific DOM element. Drag an area to record a rectangular region instead of a single point; both are location-based reports.
    ElementA problem with a button, field, or other element. Select the element before submitting.
    ConsoleAn error or message. Open console evidence, select the entry, and create the report from that context.
    NetworkA failed or unexpected request. Open network evidence, select the request, and report it with its request context.

    What evidence a report can contain

    Evidence depends on what was captured before the report and which capabilities were enabled. It may include a screenshot, nearby recorded activity, console logs, requests, element context, and source attribution. A report does not promise all logs from the entire session or a universally exact capture instant.

    Check the screenshot's state and whether it is a reporter capture or an automated capture. A queued, failed, expired, or missing image is different from a successful screenshot. Accurate screenshot capture can require browser permission.

    Use Replays for recorded activity, the frontend SDK for supported element source context, and backend evidence for the server request. Enabling capture later does not add uncaptured history to an old report.

    Visibility and comments

    Clients and guests can see public reports in their permitted review context, including reports created by other people. Do not use public visibility for staff-only details.

    Internal annotations/comments are staff workflows for project owners, developers, and testers according to effective access. Clients and guests do not gain access to internal comments by being the original reporter.

    Use public comments for reviewer discussion and internal comments for restricted staff context. Attachments and copied evidence can themselves contain sensitive application data.

    Status, assignment, and verification

    Open means the issue needs attention. In Review means it is being assessed. Resolved records a workflow decision; it does not prove a patch was applied or human verification passed. Reopened records that the issue needs more work. Won't Fix requires an explanation.

    Developers may submit a status request for approval rather than immediately changing the status; tester/owner authority and configured workflow rules differ. Check the pending result and approval queue instead of repeatedly submitting the same change.

    Configure severity deadlines and SLA settings in Project Settings → Workflow → Annotation Workflow. For the complete issue-management and sign-off process, use Managing Annotations and Verification.

    ANNOTATION TYPES

    Point

    Mark a point or drag a rectangle to identify a page location. The report includes its position or area and URL, plus any screenshot and console/network evidence available under the enabled capture permissions.

    Area

    Drag a rectangle to mark a region. Area is the rectangular selection form of a location-based report, useful for layout and spacing issues; it does not select a DOM element.

    Element

    Select a specific DOM element directly. Perfect for isolating component-level issues.

    Collab Tools

    Spotlight

    Draw attention to a specific area during live review sessions. Others' viewports will follow.

    Marker

    Draw freehand on the screen to circle or point to issues during a live session.

    An annotation can include a report-time screenshot when capture is enabled and succeeds. Check the screenshot state on the report; a missing capture is not a complete record of the page.

    Screenshot
    Critical Bug

    Dashboard_Analytics_View.png (1440x900, macOS Chrome)

    Console capture
    When available, captured messages include their level and timestamp.
    Network capture
    When available, captured requests include method, URL, status, and duration.
    Use cases
    Best for API failures, auth/session errors, and JS runtime regressions.

    CREATING AN ANNOTATION

    1Click the annotation tool in the toolbar (or press the keyboard shortcut)
    2Choose a report type: mark a point, drag an area, select an element, or select a console/network entry
    3Fill in the annotation form: Title, Comment (describe the issue), Severity
    4Click Submit, then open the saved report and check its available screenshot and evidence

    REVIEW SESSION TOOLBAR

    Point tool
    Mark a location on the page without attaching the report to a specific DOM element
    Area tool
    Drag a rectangle to mark a region; this is the area form of a location-based report, not an element selection
    Console
    View and annotate console errors
    Network
    View and annotate failed network requests
    Annotations list
    Open the sidebar showing all annotations for this session
    Invite Guest
    Generate and copy a guest review link (no account needed)
    Guided Mode
    Take control and guide all participants' viewports
    End Session
    End the current review session

    STATUS LIFECYCLE

    Open
    →
    In Review
    →
    Resolved
    /
    Won't Fix
    |
    Reopened
    Open
    New annotation, needs attention
    In Review
    Being investigated or fixed
    Resolved
    Marked resolved in the workflow; patch application and verification are separate
    Won't Fix
    Acknowledged but not going to be fixed (must provide reason)
    Reopened
    Was resolved but the issue recurred

    SEVERITY LEVELS

    Critical
    Blocks key functionality — fix immediately
    High
    Significant impact — fix this sprint
    Normal
    Standard bug — add to backlog
    Low
    Minor cosmetic issue

    Set SLA rules per-severity in Project Settings → Annotation Workflow to trigger breach alerts automatically.

    VIEWS & LAYOUTS

    Cycle views withV

    Navbar misaligned on mobile

    The menu overlaps the logo on iPhone width.

    SC
    Sarah Connor
    Nov 4

    Checkout error blocks submit

    500 from gateway when confirming order.

    JD
    John Doe
    Nov 3

    Button spacing inconsistent

    Padding is tighter than other primary actions.

    SC
    Sarah Connor
    Nov 2

    Footer link order request

    Requested reordering is intentional per brand guidelines.

    JD
    John Doe
    Nov 1

    Regression: modal close icon

    Close icon disappeared after latest release.

    SC
    Sarah Connor
    Oct 31

    FILTERS & SEARCH

    Status
    Severity
    Assigned To
    Tag
    Page URL
    Has AI Fix
    Build

    MY WORK INBOX

    Use Dashboard → My Work as your cross-project action inbox. It gathers assignments, mentions and replies, unread subscribed updates, overdue deadlines, SLA breaches, and reopened issues, with category counts and a project filter. Open a row to jump directly to its annotation; select unread rows to mark them read in bulk. The notification bell remains a short event stream, while My Work keeps action items available after the original notification is gone.

    COMMENTS, REACTIONS & TAGS

    Comments & Mentions

    Threaded comments inside each annotation. Use @username to mention team members. Internal-only comments visible only to developers, testers, and owners.

    Reactions

    React to any annotation with an emoji — like GitHub reactions. Signal agreement, urgency, or acknowledgement without leaving a comment.

    Tags

    Custom labels like auth, mobile, critical-path. Filter by tag in the toolbar.

    Subscriptions — you are automatically subscribed to annotations you create or are assigned to. For any other annotation: open it and click the bell icon → Subscribe to receive alerts for status changes, new comments, and SLA breaches.

    LINKING ANNOTATIONS

    To link: open an annotation → Links section → Add Link → search for the other annotation → choose the relationship type.

    CUSTOM TRIAGE FIELDS

    Define project-specific text, number, select, yes/no, and date fields in Project Settings → Annotation Workflow. Choose whether each field is public (available to clients and guests) or internal (staff-only), and whether it is required. Values can be entered when reporting an annotation or edited from its detail panel.

    Text
    Reproduction steps, notes
    Number
    Reproduction rate (%), story points
    Select
    Affected platform (iOS, Android, Desktop)
    Boolean
    Regression? (Yes/No)
    Date
    Target fix date

    Values are validated against their field definition by the API. A client or guest can only read or complete public fields; hiding a field in the interface is not the access-control boundary.

    REUSABLE REPORT TEMPLATES

    Project owners and developers can create reusable annotation templates in Project Settings → Annotation Workflow. A template can prefill a literal title, comment, severity, tags, assignee, and custom-field values when a report is started. Reporters can change those values before submitting. Public templates and public field defaults are available to clients and guests; internal templates and internal field defaults remain staff-only.

    Template text is used as-is. Templates do not execute scripts or dynamically substitute values.

    SLA CONFIGURATION

    Set response-time thresholds per severity, manage shared tags, and define deadlines in Project Settings → Annotation Workflow. The Annotations toolbar provides server-side overdue, due-soon, no-deadline, and SLA-breach filters.

    Critical
    e.g. 4 hours
    High
    e.g. 24 hours
    Normal
    e.g. 72 hours
    Low
    e.g. 168 hours (1 week)

    Saved views can be personal or shared with project members. Filter selections use stable URL parameters, so refreshes and shared links retain the selected triage context.

    Breach alerts are emitted as in-app + email notifications and can be forwarded to supported connected Slack or Discord channels. Microsoft Teams is marked Coming soon.

    BULK ACTIONS

    Select multiple annotations using checkboxes (or Select All). The bulk action bar appears at the bottom of the screen.

    Change status
    Assign to member
    Change severity
    Add / remove tags
    Delete

    Bulk actions are intended for list/board triage workflows and should be used by developer/owner roles to avoid accidental mass updates.

    EXPORTING ANNOTATIONS

    export.json
    json
    1[
    2 {
    3 "id": "ann_01HZ...",
    4 "title": "Button not clickable on mobile",
    5 "status": "open",
    6 "severity": "high",
    7 "pageUrl": "/checkout",
    8 "selector": "button[data-action='submit']",
    9 "assignee": "dev@example.com",
    10 "createdAt": "2025-03-26T00:00:00Z"
    11 }
    12]