Skip to content

Embedded templates, opengraph: Clarify the role of images parameter #3231

@chrillek

Description

@chrillek

It would be helpful to augment the section on the embedded OG template with a basic directory structure. Currently, the documentation exemplifies the frontmatter like so

images:
- post-cover.png

This does not make clear where "post-conver.png" must be located so that the OG template can find it.

Also, the phrase

If page bundles are used and the images array is empty or undefined, images with file names matching feature, cover, or thumbnail are used for image metadata.

is too vague, imo. I assume it means to say, "If the current page is part of a page bundle", because the passive voice used here would imply "If page bundles are used anywhere on the site", regardless of the current page. Also, it is not clear what happens if the current page is not part of a page bundle.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions