Commit graph

6 commits

Author SHA1 Message Date
ankaifeng
b3c1229518 chore: keep only the GIFs the README shows
The mp4 copies were never linked from the README once the captions went; the
GIFs are the demo.
2026-09-03 10:40:08 +08:00
ankaifeng
7fcfb0f748 chore: drop the demo recording tapes
The GIFs and mp4s under docs/ are the shipped artefacts; the vhs tapes that
produced them were session-specific (a throwaway repo, this account's paths)
and not something a contributor can re-run as written.
2026-09-03 10:36:18 +08:00
AnKaifeng
5dae0d66b5
feat: review locally with your own agent as the engine (#51)
* feat: review locally with your own agent as the engine

`review plan` prints everything a reviewer needs — files in scope with the
reasons for exclusions, per-language checklists, the P0-P3 rubric, the output
shape, the project's conventions — and `review submit` verifies positions,
dedupes, applies the gate and reports, in text, markdown or JSON. Nothing in
this path talks to OrcaRouter or needs a key; the thinking is the agent's.

- `--pr <n>` reviews a pull request by number without checking it out
- `--lang` follows the user's language through the plan, findings and report
- file selection is Open Code Review's own rules, vendored as data under
  vendor/open-code-review (Apache-2.0) with a JS port of its matcher — no
  `ocr` binary to install
- `.orcacode-review.json` holds a repo's block_on / language / exclude / rules;
  `review config` shows what applies and `review config init` writes it; the
  plan offers to create it once, after the first review
- exit 0 for a review that ran; `--fail-on-block` for hooks that want a 1;
  2 for an unusable result is never suppressed

Skills are renamed to orca-review and orca-review-action; installing the new
names retires our old ones beside them. The installer now asks how you will
use it — local, Action, or both — and `--mode` answers that for scripts.
rules/output-shape.md shows a wrong/right title pair, because a real PR got a
sixteen-word imperative title with a semicolon.

* docs: three demos — install, Action setup, local review — and a README that shows each

Recorded with vhs against a throwaway repo (docs/tapes/README.md says how).
Every prompt takes its recommended answer. The old combined demo is retired;
the two features get their own GIF, with the 3x-speed mp4 linked beside each.

* docs: README talks to the person, not the terminal

Drop the '3x · mp4' captions under the GIFs, and the menus of npx subcommands
and flags. The product is the two skills; you tell your agent what to review
and it drives the CLI. The one command that stays is the install. Flags and
the review contract are documented where a scripter looks, in --help and
skills/orca-review/references/contract.md.

* release: 2.1.0

package.json, plugin.json and marketplace.json move together, as the publish
workflow insists. The tarball check now also names the local-review files —
harness, selection, config, the vendored rules, both skills — so a files:
regression in package.json fails the release instead of shipping a plan with
no rubric.
2026-09-03 10:27:13 +08:00
AnKaifeng
fd7c58dcc6
docs: back to the GIF, no caption (#38)
A GIF plays on its own the moment the page loads. The poster-and-link form
was correct about what GitHub renders, but it still asked for a click, and a
demo nobody clicks is a demo nobody sees.

Caption dropped, including the 3× note.

demo.mp4 stays in docs/ — it is the source the GIF is rendered from, and it
is 896 KB. The poster is gone; nothing points at it now.

Repo assets: 3.6 MB.
2026-08-26 17:15:20 +08:00
AnKaifeng
1c8bfacf7a
docs: drop the GIF and the caption; the README demo is the MP4 (#37)
Removes the caption entirely and replaces the 2.7 MB GIF with the 896 KB
MP4 behind a poster frame.

GitHub will not play an MP4 referenced from a repo path. Checked against
the markdown API rather than from memory:

  <video src="docs/demo.mp4">   stripped by the sanitiser, tag gone
  ![](docs/demo.mp4)            rendered as <img src="...mp4"> — broken icon
  bare raw.githubusercontent    a plain link, no player
  <a href="mp4"><img poster>    survives intact

So the poster-and-link form is the only one that shows anything. Clicking it
opens GitHub's blob viewer, which does play MP4.

The poster is the frame where the first segment lands — the whole pitch in
one still — dimmed 14% with a play badge. The badge sits in the empty band
below the text rather than dead centre, where it would have covered "set up
OrcaCode Review in this repo", the one line worth reading.

Net: 3.6 MB of assets down to 1.2 MB.
2026-08-26 17:09:55 +08:00
AnKaifeng
2323afbc27
docs: show the demo at the top of the README (#36)
97s of recording at 3×, so it reads in half a minute: npx installs the
skill, then an agent is asked to set the repo up — once in Action mode,
once in App mode, ending on the GitHub App page.

GIF, not MP4, for the inline embed. GitHub renders video uploaded through
the web UI but not an MP4 referenced from a repo path in markdown, so an
`<img>` to a GIF is the only version that actually plays for a reader. The
MP4 is committed too and linked underneath for anyone who wants full speed
and full fidelity.

900px at 12fps, 128 colours: 2.7 MB, and the terminal text stays legible at
that width — checked, not assumed. 720px got it to 1.8 MB but softened the
smaller lines, which is the whole content here.

The caption says it is 3×. A sped-up demo that does not admit it sets a
first impression the product cannot meet.

docs/ stays out of the npm tarball — `files` is bin/, skills/, NOTICE — so
this adds nothing to install size.
2026-08-26 16:59:38 +08:00