Embed Images With Context
Images embedded in documentation, blog posts, or content pages must always include contextual framing — at minimum an alt text describing what is shown AND a caption or surrounding copy explaining why the image is releva…
$ aoe install @community/rule-embed-images-with-contextProjection
Always in _index.xml · the agent never has to ask for this.
EmbedImagesWithContext [rule] v1.0.0
Images embedded in documentation, blog posts, or content pages must always include contextual framing — at minimum an alt text describing what is shown AND a caption or surrounding copy explaining why the image is relevant. Images without contextual framing are invisible to screen readers and incomprehensible to users who cannot load them.
Loaded when retrieval picks the atom as adjacent / supporting.
EmbedImagesWithContext [rule] v1.0.0
Images embedded in documentation, blog posts, or content pages must always include contextual framing — at minimum an alt text describing what is shown AND a caption or surrounding copy explaining why the image is relevant. Images without contextual framing are invisible to screen readers and incomprehensible to users who cannot load them.
Meta
- License: Apache-2.0
- License Provenance: package-authorship-claim
Severity
warning
Applies When
Inserting any non-decorative image into a documentation page, blog post, or instructional content.
Verify By
- Alt text is present and describes the content of the image (not just its filename).
- A caption or adjacent paragraph explains the relevance or takeaway of the image.
- Decorative images (visual separators, background patterns) have alt='' (empty, not absent).
Loaded when retrieval picks the atom as a focal / direct hit.
EmbedImagesWithContext [rule] v1.0.0
Images embedded in documentation, blog posts, or content pages must always include contextual framing — at minimum an alt text describing what is shown AND a caption or surrounding copy explaining why the image is relevant. Images without contextual framing are invisible to screen readers and incomprehensible to users who cannot load them.
Meta
- License: Apache-2.0
- License Provenance: package-authorship-claim
Severity
warning
Applies When
Inserting any non-decorative image into a documentation page, blog post, or instructional content.
Verify By
- Alt text is present and describes the content of the image (not just its filename).
- A caption or adjacent paragraph explains the relevance or takeaway of the image.
- Decorative images (visual separators, background patterns) have alt='' (empty, not absent).
Relations
related: [@community/rule-image-optimization, @community/check-image-optimization, @community/rule-aria-label-required]
Rationale
An image with no alt text is a content void for screen reader users. An image with no contextual caption is ambiguous — the user must infer why it is there. Together, alt + context ensure the image contributes meaning to all users.
Meta
- License: Apache-2.0
- License Provenance: package-authorship-claim
Severity
warning
Applies When
Inserting any non-decorative image into a documentation page, blog post, or instructional content.
Verify By
- Alt text is present and describes the content of the image (not just its filename).
- A caption or adjacent paragraph explains the relevance or takeaway of the image.
- Decorative images (visual separators, background patterns) have alt='' (empty, not absent).
Source
aoe-engine/examples/frontend-design/primes/compiled/@community/rule-embed-images-with-context/atom.yaml