Skip to content

docs(readme): replace the screenshot with an English Bolt 6 one - #69

Closed
Vondry wants to merge 2 commits into
AppoloDev:mainfrom
Vondry:docs/english-screenshot
Closed

Vondry wants to merge 2 commits into
AppoloDev:mainfrom
Vondry:docs/english-screenshot

Conversation

@Vondry

@Vondry Vondry commented Oct 24, 2026 •

Copy link
Copy Markdown
Contributor

Important

Merge after #70. This PR is stacked on #70, so until #70 is merged the diff also shows its commit (fix(field): describe what the canonical link field actually overrides). The screenshot shows the Canonical Link help text from #70. Merged before it, the README would show text the editor doesn't have yet. Once #70 is merged, only the screenshot commit is left here.

Summary

This PR replaces screenshots/screenshot.png, the image in the README's "Setup" section. This PR's own commit changes no other files.

Why

The old screenshot came from the Bolt 5 admin:

  • the group label was French ("Référencement");
  • both fields showed a 70-character limit, but the defaults are now 60 for the title and 158 for the description;
  • some help texts have changed since: the shortlink text no longer says "starting with a /", the Open Graph text now says <meta property="og:type"> instead of <meta name="og:type">, and fix(field): describe what the canonical link field actually overrides #70 rewrites the Canonical Link text.

The new screenshot

  • It shows the SEO field's tab in the Bolt 6 admin, in English, with the extension's default config. The keywords field is hidden, because keywords_length is 0 by default.
  • It was taken on a fresh Bolt 6 install running this branch, so it includes fix(field): describe what the canonical link field actually overrides #70's help text. The seo field was added to pages as the README describes. English example values were typed into the form, so the Google snippet preview shows the live title, the postfix and the description. Nothing was saved.
  • The image is taken at 2x for sharp rendering on high-DPI screens, so it is 227 KB instead of 119 KB.

@Vondry
Vondry force-pushed the docs/english-screenshot branch from b8cd4ec to 8bf5346 Compare October 24, 2026 08:01
The help text said the field overrides `<link rel="canonical">`, but the
extension never outputs that tag. Bolt's CanonicalLinkWidget renders it
from Bolt's own canonical URL. The field's value is returned by
`Seo::canonical()`, which the meta tags template uses only for
`<meta property="og:url">` and `<meta property="twitter:url">`. Editors
who set it to change the canonical link saw no effect on that tag.

The help text now names those two tags, written the same way as the other
help texts, in all 15 translations. A new test checks that every string
the field template passes to `__()` has a unit in every translation file,
so a reworded text can't silently lose its translations.
The old screenshot came from the Bolt 5 admin, with a French group label
("Référencement"), 70-character limits and help texts that have changed
since. The new one shows the SEO field in the Bolt 6 admin in English,
with the default limits (60 and 158) and the current help texts.
@Vondry

Vondry commented Oct 24, 2026

Copy link
Copy Markdown
Contributor Author

Closing for now. #70 (Canonical Link help text) and #72 (removes the Shortlink field) both change what the SEO field looks like, so a new screenshot will be made once they are merged.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant