Skip to content

docs(readme): add logo, drop redundant concept section, trim asides#147

Merged
jeqcho merged 5 commits into
mainfrom
readme-logo
Jul 19, 2026
Merged

docs(readme): add logo, drop redundant concept section, trim asides#147
jeqcho merged 5 commits into
mainfrom
readme-logo

Conversation

@jeqcho

@jeqcho jeqcho commented Jul 19, 2026

Copy link
Copy Markdown
Collaborator

Summary

Three README improvements, one commit each:

  1. Logo. Adds the Inspect Robots logo (the robot-inspecting-a-dot product art from robocurve/website) centered above the title. Committed at docs/assets/inspect-robots-logo.svg with one adaptation: a cream rounded-tile background, so the cream-filled head circle reads on GitHub dark mode and PyPI instead of assuming the site's cream page. The blinking-eye CSS animation is kept and honors prefers-reduced-motion. The README references it by absolute raw.githubusercontent.com/.../main/... URL because README.md is also the PyPI long description (via hatch-fancy-pypi-readme), where relative paths break — so the image 404s until this merges.

  2. Drop "One framework, two swappable inputs". The two-inputs concept already appears in the tagline, the Inspect AI mapping table, and the Python example's comment, and the docs landing page leads with the same section — so Install moves up under the fold. The one detail stated nowhere else, the pre-rollout (policy, embodiment) compatibility check, moves to a "Why Inspect Robots" bullet.

  3. Trim over-explaining asides. Cuts detail a reader acting on each section doesn't need: the PEP 668 parenthetical, the uv-run re-sync play-by-play, the Rerun viewer memory-cap/upgrade note, the .env precedence rules, and the CaP-X adapter spec-sheet (deferred to the plugin README). Kept: the MolmoAct2 server warning, the safety-guardrails paragraph, and the Development uv lock blockquote (CONTRIBUTING.md does not cover that gotcha).

Changes

  • Add docs/assets/inspect-robots-logo.svg and reference it atop the README
  • Remove the "One framework, two swappable inputs" section; add a "Compatibility checked up front" bullet to "Why Inspect Robots"
  • Tighten Install, the uv-run note, the Rerun paragraph, agent .env setup, and the CaP-X section

Checklist

  • pre-commit install done; hooks pass (or ran pre-commit run --all-files)
  • Tests added/updated — N/A, docs-only
  • Coverage stays at 100% (pytest --cov, ran via the pre-push hook)
  • ruff check . and ruff format --check . pass (no Python files touched)
  • mypy passes (strict) — no Python files touched
  • CHANGELOG.md updated under "Unreleased" — N/A, docs-only (matches docs: add _html.py and view to the module map #138 precedent)
  • Public API changes — N/A
  • Core stays NumPy-only — no dependency changes

Related

None — standalone docs change.

🤖 Generated with Claude Code

jeqcho and others added 3 commits July 18, 2026 18:21
Copies the robot-inspecting-a-dot product art from robocurve/website into
docs/assets/, adding a cream rounded-tile background so the cream-filled
head circle reads on GitHub dark mode and PyPI. The README references it
by absolute raw.githubusercontent URL because README.md is also the PyPI
long description, where relative paths 404.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…t check

The two-inputs concept already appears in the tagline, the Inspect AI
mapping table, and the Python example, and the docs landing page leads
with the same section — so Install moves up under the fold. The one
detail stated nowhere else, the pre-rollout (policy, embodiment)
compatibility check, moves to a Why Inspect Robots bullet.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Cuts detail a reader acting on the section doesn't need: the PEP 668
parenthetical, the uv-run re-sync play-by-play, the Rerun viewer memory
cap and upgrade note, the .env precedence rules, and the CaP-X adapter
spec-sheet (now deferred to the plugin README).

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@jeqcho jeqcho changed the title docs(readme): add the Inspect Robots logo above the title docs(readme): add logo, drop redundant concept section, trim asides Jul 19, 2026
jeqcho and others added 2 commits July 18, 2026 18:55
Subtitle becomes 'evaluating AI and robots in the physical world';
the tagline's italicized any-s go roman. Cuts the uv-run note's remedy
sentence, the wizard parentheticals, and restructures the buried
--store-frames conditional into the sentence.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…e bullet

inspect-robots-maniskill and inspect-robots-openvla were aspirational
examples that don't exist; point at inspect-robots-yam and the
first-party plugins instead. Subtitle 'evaluating' -> 'benchmarking'
to stop echoing 'evaluation framework'.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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