Skip to content

docs: clarify Linux screenshot capture support #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ooonea wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: clarify Linux screenshot capture support #23

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -266,8 +266,9 @@ Before finishing code changes:
the `disallowed_methods` deny is part of Prime Directive enforcement; a
hit means move the call off-thread, not silence the lint.
- Run `cargo test` unless the change is docs-only.
- For UI changes, render at least one screenshot with
`cargo run --bin ferail-gpui -- --screenshot ...` and inspect it.
- For UI changes, capture and inspect at least one screenshot. On Linux, use
the compositor; GPUI does not implement offscreen capture there. On macOS
and Windows, use `cargo run --bin ferail-gpui -- --screenshot ...`.
- Write screenshots to `screenshots/<feature>.png`, not `/tmp`.
`screenshots/` is gitignored scratch, any image a committed document
references (README, docs/) must live in `docs/images/` instead, or it
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ adding cross-crate dependencies.
- `python3 scripts/check-docs.py` when the change touches Markdown. The
documentation rules it enforces are in
[docs/DOCUMENTATION.md](docs/DOCUMENTATION.md).
- For UI changes, attach a screenshot. Generate one headlessly:
- For UI changes, attach a screenshot. On Linux, capture the running window
through the compositor; GPUI does not implement offscreen capture there.
On macOS and Windows, generate one headlessly:

```sh
cargo run --bin ferail-gpui -- \
Expand Down