OpenPress

@openpress-comment

コメントマーカー

インラインレビューマーカーは、ソースコード内で MDX コメントとして存在します。Workbench はそれらを番号付きのピンとしてレンダリングし、エージェントは apply-comments ワークフローを使用してそれらを処理します。外部のコメントデータベースはありません。

このドキュメントでは、OpenPress ドキュメントにインラインコメントを追加および処理する方法を説明します。

Workbench を使用してコメントを追加する(人間のユーザー)

プレビュー画面を表示している場合は、以下の手順に従ってコメントを追加します:

  1. 開発サーバーが起動していることを確認します (npm run dev)。
  2. ブラウザでプレビューを開きます(例:http://127.0.0.1:5173/workspace)。
  3. 画面のツールバーから Inspector をクリックして開きます。
  4. マークしたい段落ブロック(またはブロック間のキャレット)をクリックし、Add comment をクリックします。
  5. コメントテキストを入力し、Cmd/Ctrl + Enter を押して送信します。
  6. Workbench は自動的にコメントマーカーを MDX ソースコードに書き込み、保存します。

エディタを使用して手動でコメントを追加する(Agent)

MDX ファイルに手動でコメントを挿入する必要がある場合は、以下の手順に従います:

  1. ターゲットの MDX ファイルを開きます。
  2. マークする必要があるテキストの段落を見つけます。
  3. その段落の後に標準の MDX コメント形式を挿入します。一意の id と作成時間 ts が含まれていることを確認してください:
{/* @openpress-comment id="c-2026-05-28-unique-id" ts="2026-05-28T12:34:00Z" text="コメントの内容" author="作成者名" */}

コメントの処理と削除

コメントを解決する場合は、以下の手順に従います:

  1. ソースコード内のコメントテキストとコンテキストを読みます。
  2. コメントの要件に従ってソースコードを変更します。
  3. 変更が正しく適用されたことを確認した後、コメントマーカーの行を削除します
  4. コメントの内容が不明確であるか、実行できない場合は、マーカーを保持するか、詳細な TODO 説明に置き換えます。
  5. ファイル間で同じ id を直接再利用しないでください。段落をコピーした場合は、新しいコメント用に新しい id を生成してください。