docs: generate the listing images instead of committing them

The five PNGs are generated output, like the build ZIP, so they leave
git and docs/amo/screenshots/ is ignored. The README's command produces
them, and with squash merges they never reach develop or main, so the
repository needs no Git LFS.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
golem
2026-10-18 23:22:20 -06:00
co-authored by Claude Opus 5.5
parent ac734aa3db
commit 71fa5ddbc8
8 changed files with 16 additions and 5 deletions
+2
View File
@@ -2,3 +2,5 @@
node_modules/ node_modules/
web-ext-artifacts/ web-ext-artifacts/
npm-debug.log* npm-debug.log*
# Listing images are generated; see docs/amo/README.md.
docs/amo/screenshots/
+9 -3
View File
@@ -60,6 +60,11 @@ prints the ZIP's path.
Upload in this order, with these captions. Each image is 1280×800, the size AMO Upload in this order, with these captions. Each image is 1280×800, the size AMO
recommends, and carries no added text, as Mozilla's listing guide advises. recommends, and carries no added text, as Mozilla's listing guide advises.
The images are not committed. Generate them as described under
[Regenerating the images](#regenerating-the-images); they land in
`docs/amo/screenshots/`, which git ignores, so the links below work once you
have.
| Image | Caption | | Image | Caption |
|---|---| |---|---|
| [1-address-bar.png](screenshots/1-address-bar.png) | Type gpt and your question in the address bar. ChatGPT opens with it filled in. | | [1-address-bar.png](screenshots/1-address-bar.png) | Type gpt and your question in the address bar. ChatGPT opens with it filled in. |
@@ -75,9 +80,10 @@ Suggested caption: "Every setting on one simple page."
## Regenerating the images ## Regenerating the images
The images are the options page's drawings, enlarged by The images are the options page's drawings, enlarged by
[`screenshots.html`](screenshots.html), which reuses `options/options.css`. When [`screenshots.html`](screenshots.html), which reuses `options/options.css`. They
a drawing in `options/options.html` changes, copy the change into are generated rather than committed, like the build ZIP. When a drawing in
`screenshots.html`, then run these from the repository root: `options/options.html` changes, copy the change into `screenshots.html`. Then,
to produce the images, run these from the repository root:
```sh ```sh
python3 -m http.server 8766 --bind 127.0.0.1 & python3 -m http.server 8766 --bind 127.0.0.1 &
Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

@@ -1,7 +1,8 @@
# Add-ons listing for 1.3 # Add-ons listing for 1.3
Status: implemented on `docs/24-amo-listing-add-screenshots-and-a` (#24). The Status: implemented on `docs/24-amo-listing-add-screenshots-and-a` (#24). The
paste-ready text, captions, and images are in [`docs/amo/`](../../amo/README.md). paste-ready text and captions are in [`docs/amo/`](../../amo/README.md), along
with the page that renders the images.
## Problem ## Problem
@@ -46,6 +47,8 @@ use the extension.
upload order, and how to regenerate the images. upload order, and how to regenerate the images.
- `docs/amo/screenshots.html`: the drawing markup at 1280×800, one image per - `docs/amo/screenshots.html`: the drawing markup at 1280×800, one image per
`#fragment`, styled by `options/options.css`. `#fragment`, styled by `options/options.css`.
- `docs/amo/screenshots/*.png`: the five rendered images. - `docs/amo/screenshots/*.png`: the five rendered images. They are generated
and git-ignored rather than committed, so the repository carries no binaries
and needs no Git LFS. The command to produce them is in the README.
`docs/` is excluded from the extension package, so none of this ships to users. `docs/` is excluded from the extension package, so none of this ships to users.