Skip to content

[codex] Add block range annotations design doc#332

Open
Stvad wants to merge 2 commits into
masterfrom
codex/block-range-annotations-design-doc
Open

[codex] Add block range annotations design doc#332
Stvad wants to merge 2 commits into
masterfrom
codex/block-range-annotations-design-doc

Conversation

@Stvad

@Stvad Stvad commented Jul 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • Adds a high-level HTML design doc for block range annotations and comments.
  • Captures the proposed block-backed thread model, block-local hybrid anchors, UI surfaces, edit suggestions, storage tradeoffs, implementation slices, and open questions.

Why

This records the design direction for Google Docs-style comments over selected block text before implementation work starts. The core architectural call is to keep comment threads as normal blocks while storing anchors as separate block-local selector payloads, with highlights derived in the UI.

Validation

  • yarn run check

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://Stvad.github.io/knowledge-medium/pr-preview/pr-332/

Built to branch gh-pages at 2026-07-07 04:36 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@Stvad Stvad marked this pull request as ready for review July 7, 2026 01:42

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: bc926782f6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

<p>Each comment thread root is a block with a dedicated type, a deterministic annotation-container parent, and a small property payload.</p>

<pre><code>parentId: "annotation-container-for-workspace"
types: ["annotation:thread"]

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Store annotation type in properties

When the v1 code follows this example, the annotation thread won't be discoverable by type because this repo does not have a top-level types field: BlockData exposes only properties, and the block_types index is populated from properties_json.$.types (src/data/internals/clientSchema.ts). Please show "types" inside the properties payload (encoded via typesProp) so creation/query code writes the field that existing type queries actually index.

Useful? React with 👍 / 👎.

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