Website: show the editor companions (JetBrains IDEs, Zed) on the home page, with screenshots #71

Closed
opened 2026-11-12 01:54:35 +01:00 by thatrichan · 4 comments
Owner

The website (revue-server, server/src/site/pages.rs) never mentions that Revue works from your editor. The JetBrains plugin Revue Companion (Marketplace) and the Zed task (editors/zed) are only in docs/editors.md. Visitors should see them on the home page, presented as nicely as the rest of the page: screenshots, dark and light.

What the page gets

A new section on the home page (home()), after Beyond the diff (#code), in the same style (spotlight, split, eyebrow, ul.ticks). For example:

  • Eyebrow In your editor, heading like "Your pull requests, next to your code".
  • A short lead: open your branch's pull request in Revue, or start a new one, from the IDE. See the repository's open pull requests in a sidebar.
  • Ticks:
    • JetBrains IDEs (IntelliJ IDEA, WebStorm, PyCharm, GoLand, Rider, CLion, RustRover…): the Revue tool window with pull requests as cards, Revue: Pull Request from the Git menu or Find Action, and a pull request opening in the window that has its branch.
    • Zed: the Revue: Pull Request task, with a key binding.
    • Coming later: more editors (VS Code…), only if that's decided by the time this ships (see #68).
  • Actions: Get Revue Companion (its public JetBrains Marketplace page), and Set up your editor (the editors doc page on the site, site/docs.rs).
  • Optional: one line in the hero's p.small or in the downloads page (downloads()) pointing at the section: "Works from JetBrains IDEs and Zed".

Screenshots

Two or three new Shots, dark and light, listed in shots() so the gallery viewer goes through them, and in ASSETS:

  1. ide-tool-window: a JetBrains IDE with the Revue tool window open, its pull request cards beside the code.
  2. ide-open: the Revue: Pull Request action (Git menu or Find Action), or the pull request it opened in Revue next to the IDE.
  3. Optional zed-task: Zed's task picker with Revue: Pull Request.

Use the light/dark IDE themes that match the app's screenshots (Catppuccin, as in task shoot:site) so the page looks of a piece. Crop to the interesting part; the same sizes as OPEN_IN.

Nothing private in them

Every screenshot must show only made-up, public-safe data, like the existing ones:

  • The repository open in the IDE is a throwaway project whose remote is the demo's (tidewater/atlas-api, tidewater/atlas-web), and the pull requests come from revue --demo. If the companion can't get demo answers through the revue command today, make it able to (e.g. the demo answering --pulls / --branch-pull) rather than pointing it at a real account.
  • No real repository, organisation, branch or ticket names, no usernames, avatars or emails, no home folder paths (title bar, project tree, terminal), no other open projects in the IDE's recent list, no tokens, no notifications.
  • No private repositories, including our own: link only to public pages (the Marketplace listing and the site's docs), never to a private repo's source.
  • Check every image at full size, both themes, before committing.

Taking them

Extend task shoot:site if the IDE can be driven reproducibly (e.g. a script-free launch of the IDE with a prepared project and the demo running); otherwise add a task that sets up the demo project and the demo app, and document the manual capture steps in the task's description. Until a screenshot exists, the Shot uses name: None (the "Screenshot to come" placeholder), so the section can ship first.

Done when

  • The home page has the section in both themes, at phone width too (no horizontal scroll).
  • The screenshots open in the gallery viewer.
  • docs/editors.md and the page use the same names (Revue Companion, Revue: Pull Request).
  • The site's tests (server/src/site) cover the new section's links.
The website (revue-server, `server/src/site/pages.rs`) never mentions that Revue works from your editor. The JetBrains plugin **Revue Companion** (Marketplace) and the Zed task (`editors/zed`) are only in `docs/editors.md`. Visitors should see them on the home page, presented as nicely as the rest of the page: screenshots, dark and light. ## What the page gets A new section on the home page (`home()`), after **Beyond the diff** (`#code`), in the same style (`spotlight`, `split`, `eyebrow`, `ul.ticks`). For example: - Eyebrow **In your editor**, heading like *"Your pull requests, next to your code"*. - A short lead: open your branch's pull request in Revue, or start a new one, from the IDE. See the repository's open pull requests in a sidebar. - Ticks: - **JetBrains IDEs** (IntelliJ IDEA, WebStorm, PyCharm, GoLand, Rider, CLion, RustRover…): the Revue tool window with pull requests as cards, **Revue: Pull Request** from the Git menu or Find Action, and a pull request opening in the window that has its branch. - **Zed**: the **Revue: Pull Request** task, with a key binding. - Coming later: more editors (VS Code…), only if that's decided by the time this ships (see #68). - Actions: **Get Revue Companion** (its public JetBrains Marketplace page), and **Set up your editor** (the editors doc page on the site, `site/docs.rs`). - Optional: one line in the hero's `p.small` or in the downloads page (`downloads()`) pointing at the section: "Works from JetBrains IDEs and Zed". ## Screenshots Two or three new `Shot`s, dark and light, listed in `shots()` so the gallery viewer goes through them, and in `ASSETS`: 1. `ide-tool-window`: a JetBrains IDE with the Revue tool window open, its pull request cards beside the code. 2. `ide-open`: the **Revue: Pull Request** action (Git menu or Find Action), or the pull request it opened in Revue next to the IDE. 3. Optional `zed-task`: Zed's task picker with **Revue: Pull Request**. Use the light/dark IDE themes that match the app's screenshots (Catppuccin, as in `task shoot:site`) so the page looks of a piece. Crop to the interesting part; the same sizes as `OPEN_IN`. ### Nothing private in them Every screenshot must show **only made-up, public-safe data**, like the existing ones: - The repository open in the IDE is a throwaway project whose remote is the demo's (`tidewater/atlas-api`, `tidewater/atlas-web`), and the pull requests come from `revue --demo`. If the companion can't get demo answers through the `revue` command today, make it able to (e.g. the demo answering `--pulls` / `--branch-pull`) rather than pointing it at a real account. - No real repository, organisation, branch or ticket names, no usernames, avatars or emails, no home folder paths (title bar, project tree, terminal), no other open projects in the IDE's recent list, no tokens, no notifications. - No private repositories, including our own: link only to public pages (the Marketplace listing and the site's docs), never to a private repo's source. - Check every image at full size, both themes, before committing. ### Taking them Extend `task shoot:site` if the IDE can be driven reproducibly (e.g. a script-free launch of the IDE with a prepared project and the demo running); otherwise add a task that sets up the demo project and the demo app, and document the manual capture steps in the task's description. Until a screenshot exists, the `Shot` uses `name: None` (the "Screenshot to come" placeholder), so the section can ship first. ## Done when - The home page has the section in both themes, at phone width too (no horizontal scroll). - The screenshots open in the gallery viewer. - `docs/editors.md` and the page use the same names (**Revue Companion**, **Revue: Pull Request**). - The site's tests (`server/src/site`) cover the new section's links.
Author
Owner

The section is in 73be098: "In your editor", after "Beyond the diff" (#editors), plus a line in the hero linking to it.

  • Content: ticks for JetBrains IDEs and Zed, and buttons Get Revue Companion and Set up your editor. VS Code isn't mentioned.
  • Names: the page follows docs/editors.md. The JetBrains action is Revue: Open Pull Request and the Zed task is Revue: Pull Request.
  • Marketplace link: there's no listing URL in the repository yet, so the button goes to a Marketplace search. To change it, edit the COMPANION constant in server/src/site/pages.rs.
  • Screenshots: the three shots (ide-tool-window, ide-open, zed-task) are name: None placeholders. shots() skips them until they're named.
  • Tests: a site test covers the links, the anchors in the editors doc, and that the page and the doc use the same names.

Left:

  • Demo answers for --pulls / --branch-pull.
  • A capture task, and the six screenshots (dark and light), checked by hand.
  • The real Marketplace URL.
The section is in 73be098: "In your editor", after "Beyond the diff" (`#editors`), plus a line in the hero linking to it. - **Content:** ticks for JetBrains IDEs and Zed, and buttons **Get Revue Companion** and **Set up your editor**. VS Code isn't mentioned. - **Names:** the page follows `docs/editors.md`. The JetBrains action is **Revue: Open Pull Request** and the Zed task is **Revue: Pull Request**. - **Marketplace link:** there's no listing URL in the repository yet, so the button goes to a Marketplace search. To change it, edit the `COMPANION` constant in `server/src/site/pages.rs`. - **Screenshots:** the three shots (`ide-tool-window`, `ide-open`, `zed-task`) are `name: None` placeholders. `shots()` skips them until they're named. - **Tests:** a site test covers the links, the anchors in the editors doc, and that the page and the doc use the same names. Left: - Demo answers for `--pulls` / `--branch-pull`. - A capture task, and the six screenshots (dark and light), checked by hand. - The real Marketplace URL.
Author
Owner

Get Revue Companion now opens the plugin's own Marketplace page, https://plugins.jetbrains.com/plugin/36021-revue-companion (fd62405), instead of a search. docs/editors.md links to it too. The screenshots are still to come.

**Get Revue Companion** now opens the plugin's own Marketplace page, https://plugins.jetbrains.com/plugin/36021-revue-companion (fd62405), instead of a search. `docs/editors.md` links to it too. The screenshots are still to come.
Author
Owner

The demo can now answer for the editors (7f75f98), and there's a capture task (7f51329).

  • A revue --demo app now answers editors' questions. --demo (or REVUE_DEMO=1 in the environment) asks the running demo's window. With --headless and no window, it answers from the mock services in a throwaway folder. It never asks the real app or uses real sign-ins. A test runs the real binary and checks that every answer is tidewater/ data only.
  • task shoot:editors MODE=dark|light [IDE=idea|…] starts the demo and sets up a throwaway atlas-api project on atl-412-tile-cache, the head of demo PR #214. It also writes the Zed task and a clean, separate JetBrains profile. Then it prints the capture steps and the privacy checklist.

Left: taking the six screenshots by hand with that task, then setting the names in EDITORS and adding the files to ASSETS, as the comment above EDITORS describes.

The demo can now answer for the editors (7f75f98), and there's a capture task (7f51329). - A `revue --demo` app now answers editors' questions. `--demo` (or `REVUE_DEMO=1` in the environment) asks the running demo's window. With `--headless` and no window, it answers from the mock services in a throwaway folder. It never asks the real app or uses real sign-ins. A test runs the real binary and checks that every answer is `tidewater/` data only. - `task shoot:editors MODE=dark|light [IDE=idea|…]` starts the demo and sets up a throwaway `atlas-api` project on `atl-412-tile-cache`, the head of demo PR #214. It also writes the Zed task and a clean, separate JetBrains profile. Then it prints the capture steps and the privacy checklist. Left: taking the six screenshots by hand with that task, then setting the `name`s in `EDITORS` and adding the files to `ASSETS`, as the comment above `EDITORS` describes.
Author
Owner

The section, the Marketplace link, demo answers for editors, and task shoot:editors are all shipped. The screenshots are deferred to #73, so I'm closing this one.

The section, the Marketplace link, demo answers for editors, and `task shoot:editors` are all shipped. The screenshots are deferred to #73, so I'm closing this one.
Sign in to join this conversation.
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
thatrichan/revue#71
No description provided.