OpenPress

@openpress-comment

Comment Markers

Inline review markers exist as MDX comments in the source code. The Workbench renders them as numbered pins; agents use the apply-comments workflow to process them. There is no external comment database.

This document explains how to add and process inline comments in OpenPress documents.

Adding Comments via Workbench (Human User)

If you are browsing the preview screen, follow these steps to add a comment:

  1. Ensure the development server is running (npm run dev).
  2. Open the preview in your browser (e.g., http://127.0.0.1:5173/workspace).
  3. Click to open the Inspector from the toolbar on the screen.
  4. Click on the paragraph block you want to mark (or the insertion bar between blocks), then click Add comment.
  5. Enter your comment text and press Cmd/Ctrl + Enter to submit.
  6. The Workbench will automatically write the comment marker into the MDX source code and save it.

Adding Comments Manually via Editor (Agent)

If you need to manually insert a comment in an MDX file, follow these steps:

  1. Open the target MDX file.
  2. Locate the text paragraph that needs to be marked.
  3. Insert the standard MDX comment format after the paragraph. Ensure it includes a unique id and creation time ts:
{/* @openpress-comment id="c-2026-05-28-unique-id" ts="2026-05-28T12:34:00Z" text="Your comment content" author="Author Name" */}

Processing and Removing Comments

When you want to resolve a comment, follow these steps:

  1. Read the comment text and context in the source code.
  2. Modify the source code to address the comment’s request.
  3. After confirming the modification is applied correctly, delete the comment marker line.
  4. If the comment content is not clear enough or unactionable, leave the marker, or replace it with a detailed TODO note.
  5. Never reuse the same id across files directly. If you duplicate a paragraph, generate a new id for the new comment.