Skip to content

Docs reference Insertion/Replacement capabilities, but they don't exist in the UI #617

@vxio

Description

@vxio

Problem

The marketing site, ANNOTATE.md, and several blog posts describe four annotation types — Deletion, Replacement, Comment, Insertion (plus Global Comment) — but the shipped UI only implements three.

Code (source of truth)

packages/ui/types.ts:

export enum AnnotationType {
  DELETION       = 'DELETION',
  COMMENT        = 'COMMENT',
  GLOBAL_COMMENT = 'GLOBAL_COMMENT',
}

The floating toolbar in AnnotationToolbar.tsx renders: Copy, Delete, Comment, Quick label (⚡), Looks good (👍), Cancel. No insert/replace.

Docs claiming otherwise

Screenshot:

Image
File What it says
apps/marketing/src/content/docs/getting-started/quickstart.md Lists Delete / Replace / Comment / Insert as toolbar choices
apps/marketing/src/content/docs/getting-started/ui-settings.md "Selection (default) — choose an annotation type from the toolbar (comment, deletion, replacement, insertion)"
apps/marketing/src/content/docs/commands/plan-review.md Full table including Replacement and Insertion rows
apps/marketing/src/content/docs/commands/annotate.md "deletions, replacements, comments, insertions, global comments"
apps/marketing/src/content/blog/welcome.md "deletions, replacements, comments, and insertions"
apps/marketing/src/content/blog/plannotator-meets-pi.md "comments, deletions, replacements, insertions"
apps/portal/ANNOTATE.md Lists all four annotation types

History

Both INSERTION and REPLACEMENT enum values existed from the initial commit (92d4f73) through 4627f75 feat: external annotations API with real-time SSE (#400). They're absent in main after that — so this is a removal, not a never-built feature.

git log --all --oneline -S "INSERTION" -- '*.ts' '*.tsx'
git log --all --oneline -S "REPLACEMENT" -- '*.ts' '*.tsx'

Both end at #400.

Question for maintainer

Was the removal intentional?

  • Yes, intentional → I'll send a PR scrubbing Insert/Replace from the 7 docs files and updating them to reflect the Delete + Comment + Global Comment + Quick Labels reality.
  • No, regression → leave docs alone; the fix belongs in code (restore the enum values + toolbar buttons).
  • Planned re-add → close as tracked elsewhere; happy to follow that issue instead.

Happy to do whichever once direction is clear.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions