docs: AMO listing: add screenshots and a description that covers every way to use the extension (#24)
docs/amo/README.md holds a paste-ready summary, description and screenshot captions for the 1.3 listing. The copy covers the address bar, right-click, keyboard shortcut and toolbar button, says the extension is small on purpose, and follows the "filled in, never sent" copy rule. A cat joke replaces the programmer joke. The five 1280x800 images are the options page's drawings, enlarged by docs/amo/screenshots.html and rendered with headless Firefox. The README explains how to regenerate them. docs/ stays out of the package. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
@@ -0,0 +1,51 @@
|
||||
# Add-ons listing for 1.3
|
||||
|
||||
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).
|
||||
|
||||
## Problem
|
||||
|
||||
The AMO listing had no screenshots, and its description covered only the `gpt`
|
||||
keyword. It never mentioned right-click, the keyboard shortcut, or the toolbar
|
||||
button. The listing is where newcomers decide to install and first learn how to
|
||||
use the extension.
|
||||
|
||||
## Decisions
|
||||
|
||||
- **Tone: clear, with one joke.** The copy gives plain steps for newcomers. A
|
||||
general cat joke ("gpt why does my cat knock things over?") replaces the old
|
||||
programmer joke ("sudo make me a sammich"), and the images share the cat
|
||||
theme.
|
||||
- **Say it is small.** Customization without bloat is what sets this extension
|
||||
apart, so the description has a "Small on purpose" section: about 56 KB, no
|
||||
libraries, no server, no API key, no intermediary, and nothing reported to
|
||||
us. These are the README's privacy claims; nothing new is claimed.
|
||||
- **Drawings as screenshots.** The images are the options page's drawings,
|
||||
enlarged and rendered by headless Firefox:
|
||||
- They are part of the extension's own UI.
|
||||
- They stay sharp and on brand.
|
||||
- They can be regenerated after UI changes.
|
||||
|
||||
Real screenshots would show OS-specific menus and go stale. A real
|
||||
screenshot of the options page is suggested as a sixth image, taken by the
|
||||
maintainer, because one genuine screenshot builds trust in the rest.
|
||||
- **AMO's guidance.** Images are 1280×800, the size AMO recommends and its
|
||||
largest display size, and carry no added text. Explanations go in each image's
|
||||
caption.
|
||||
- **The copy rule holds.** ChatGPT opens with the text filled in; it is never
|
||||
sent, searched, or asked. Temporary chat and web search are described as
|
||||
hints, and "private", "incognito", and "secure" appear nowhere near temporary
|
||||
chat.
|
||||
- **Correction from the draft.** The description does not say ChatGPT opens "in
|
||||
a new tab": `gpt` searches open in the current tab, and the other ways follow
|
||||
the Open ChatGPT in setting.
|
||||
|
||||
## Files
|
||||
|
||||
- `docs/amo/README.md`: summary, description (AMO's HTML subset), captions in
|
||||
upload order, and how to regenerate the images.
|
||||
- `docs/amo/screenshots.html`: the drawing markup at 1280×800, one image per
|
||||
`#fragment`, styled by `options/options.css`.
|
||||
- `docs/amo/screenshots/*.png`: the five rendered images.
|
||||
|
||||
`docs/` is excluded from the extension package, so none of this ships to users.
|
||||
Reference in New Issue
Block a user