Skip to content

Add optional human-review checkpoint for research documents #3

Description

@kylymo

Summary

Adapt the upstream human-review skill for this repository as an optional, user-invoked review checkpoint for academic and thesis workflows.

Proposed scope

Add skills/human-review/SKILL.md with portable instructions to:

  • open Markdown, HTML, or localhost-rendered research documents in the visual review tool;
  • let the author directly edit prose and leave anchored comments on claims, paragraphs, figures, and tables;
  • consume the structured feedback batch returned by Human Review;
  • apply edits back to the original Markdown/HTML/MDX source rather than overwriting rendered output;
  • preserve LaTeX syntax when a reviewed artifact is derived from LaTeX;
  • require a backup or Git checkpoint before applying changes.

Update the README skill table and document the integration as an optional stage, for example:

finalize -> human-review -> logic-check
thesis-review -> human-review -> revision

Constraints

  • Keep the Human Review application itself external; do not vendor the full Node application into this repository.
  • Support Markdown/HTML/localhost directly. For LaTeX, use a rendered review artifact and map approved edits back to the source.
  • Preserve upstream MIT attribution: https://github.com/petergyang/human-review
  • Keep the stage user-invoked and do not make it run automatically as part of finalize.

Acceptance criteria

  • skills/human-review/SKILL.md passes the repository validator.
  • Instructions work with the upstream npx -y human-review CLI.
  • The skill handles all pages in a returned feedback batch, including edits, comments, and deletions.
  • The skill explicitly prevents writing rendered HTML back over LaTeX or other source files.
  • README documents installation, usage, scope, and attribution.
  • python3 scripts/validate_skills.py and git diff --check pass.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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