mcpField
O
openpress-apply-comments

openpress-apply-comments

github.com/quan0715Documents1460 installsUpdated 9w ago
Repository

About openpress-apply-comments

A workflow skill for Agents maintaining OpenPress documents, focused on turning pending @openpress-comment markers into source edits. It guides small, scoped changes, marker removal after resolution, and verification.

Key features

  1. 01Find pending comment markers
  2. 02Read notes and nearby source
  3. 03Make requested source edits
  4. 04Remove markers after edits
  5. 05Verify and report outcomes

Use cases

  1. 01Apply review comments to document sources one at a time
  2. 02Check that resolved markers are cleared after edits
  3. 03Keep ambiguous or failed comments in place

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/quan0715/open-press --skill openpress-apply-comments

After installing, type/openpress-apply-commentsin Claude Code to confirm it loaded.

Details

From the project README

open-press Apply Comments

This is the workflow skill for turning pending @openpress-comment markers into source edits. A comment is resolved only when the requested source change has been made and the marker has been removed.

openpress-collaborate owns whether the agent should propose, refresh, apply a reviewed preview, or edit directly. Use this skill for marker mechanics. If the user asks to apply .openpress/review/current.json, return to openpress-collaborate instead of interpreting the Comments as a separate direct-edit batch.

Responsibilities

  • List pending @openpress-comment markers.
  • Read the decoded comment note, hint, source path, and nearby source.
  • Apply the requested edit as a small source change.
  • Remove the marker after the edit is complete.
  • Leave ambiguous or failed comments in place.
  • Verify before reporting completion.

Boundary

  • Use openpress for the canonical source/generated path table when unsure.
  • Edit source, not generated output.
  • Default to editing the source file that contains the marker.
  • Route domain-heavy work to the owning skill:
    • openpress-create-pages for page prose, hierarchy, captions, claims, tone, narrative, page theme, and page components.
    • openpress-create-slide for deck narrative, slide density, direct slide sources, active theme tokens, core Object API composition, Tailwind semantic styling, and reusable UI primitives.
    • openpress-plugins for external diagramming, visual tools, and writing helpers.
  • Do not rewrite unrelated sections while resolving one comment.

Workflow

  1. Discover comments.

    rg "@openpress-comment" press -n
    

    If decoded notes are needed and the framework helper exists, use it:

    node --input-type=module -e 'import { listCommentMarkers } from "./packages/core/engine/react/comment-marker.mjs"; console.log(JSON.stringify(await listCommentMarkers({ root: process.cwd() }), null, 2));'
    
  2. Pick the requested scope.

    • If the user names one comment, resolve only that comment.
    • If the user says apply comments without an id, process pending comments in source order.
    • Handle comments one at a time; do not batch unrelated rewrites under one marker.
  3. Inspect the target.

    • Read the source file that contains the marker.
    • Inspect nearby lines before editing.
    • Use the marker hint and rendered-object metadata when present, but verify against source.
  4. Apply the edit.

    • Make the smallest source change that satisfies the comment.
    • Preserve local style, component APIs, and MDX structure.
    • If the request is ambiguous, ask for clarification and leave the marker in place.
  5. Remove the resolved marker.

    • Delete the @openpress-comment marker only after the source edit is complete.
    • Do not clear a marker just because it was read.
    • Clear a marker without applying only when the user explicitly asks.
  6. Verify.

    npm run build
    

    build validates structure and renders the full output. When iterating fast on the inner steps:

    node engine/cli.mjs validate .   # structural checks only, no render
    node engine/cli.mjs export .     # rewrite document.json only, no Vite bundle
    

Completion Report

Report:

  • which comment ids were resolved,
  • which files changed,
  • which comments remain because they were ambiguous or failed,
  • which verification commands ran and whether they passed.

Common Mistakes

  • Do not edit public/openpress/, dist-react/, .deploy/, or .openpress/. The separate openpress-collaborate workflow alone owns .openpress/review/current.json.
  • Do not remove unresolved comments.
  • Do not rewrite broad sections unless the comment explicitly asks for that.
  • Do not claim the browser changed until the source has been exported when export is required.

Comments

Markdown supported