Skip to content

docs: add AGENTS.md with a prompt to get the viewer running - #13

Merged
bregydoc merged 2 commits into
mainfrom
docs/agent-run-prompt
Oct 6, 2026
Merged

bregydoc merged 2 commits into
mainfrom
docs/agent-run-prompt

Conversation

@bregydoc

@bregydoc bregydoc commented Oct 6, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Add AGENTS.md as the canonical entry point for coding agents asked to run or integrate Hyper: the uvx launch commands, accepted inputs, the Python API path, and the in-checkout commands.
  • Link to it from a collapsed Ask a coding agent to run it block in the README, placed just before the Install uv instructions.

Why this shape

The first commit put an expanded ### For agents section above the human quick start. That introduced the only h3 in a README that is otherwise all h2 plus <details> blocks, and it restated the uvx command and wheel matrix that appear ~10 lines below — two places to update whenever either changes.

AGENTS.md is the conventional file agents look for and holds the detail once. The README block is collapsed like the existing Use pip instead of uv and Run from source blocks, so the one-line human command stays the first thing under the heading.

AGENTS.md also records the constraint agents most often get wrong: the viewer opens a native window on the machine running the command, so a remote host or container cannot display on the user's laptop.

Verification

  • cargo run --locked -p hyper-viz --example project_scene — passes, no window
  • cargo run --locked -- --help — exits cleanly with no window; confirms --help is headless-safe as documented. Args::parse() precedes all window setup in src/main.rs
  • All five relative links in AGENTS.md resolve
  • README heading structure re-checked: no stray h3, three consistent <details> blocks
  • Not exercised: the published uvx path and the GUI itself

Coding agents need a pasteable prompt that launches the published viewer without a checkout or Rust toolchain.
AGENTS.md is the conventional agent entry point and keeps the commands,
platform matrix, and desktop-session constraint in one place. The README
links to it from a collapsed block, matching the existing pip and
from-source blocks, so the human quick start stays first.
@bregydoc bregydoc changed the title docs: add an agent prompt before the uv install step docs: add AGENTS.md with a prompt to get the viewer running Oct 6, 2026
@bregydoc
bregydoc merged commit 2f4d4d5 into main Oct 6, 2026
16 checks passed
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