Skip to content

Document the resources page's embedded-video convention in AGENTS.md #566

Description

@fullsend-ai-retro

What happened

On PR #548 a new resource entry for the Red Hat Summit 2026 demo initially shipped without an embedded video iframe. The fullsend review agent flagged the missing {{< rawhtml >}} embed as a low structural-consistency finding, softening it because a prior article-only entry also omitted the embed. A human maintainer (simonbaird) then submitted a change-request review asking for an embedded video player. The contributor added an iframe embed in a follow-up push and the change was accepted. website/content/resources/_index.md contains 5+ YouTube iframe embeds already, so the convention is clearly established in the code; it just is not written down anywhere the reviewer can point to as a firm rule.

What could go better

The delta between the agent review and the human review is the severity assigned to the missing embed. The agent read the file, noticed the convention, but treated one counter-example (an article-only entry) as license to downgrade the finding to low. The human treated the same signal as change-requesting. If the convention were documented as a rule in AGENTS.md, the review agent would have a firm anchor to raise the finding to at least medium, and future contributors would know the expectation up front — closing the delta without further human intervention. Uncertainty: I am confident the site already follows this convention and confident that documenting it would move the agent's severity assignment; I am less sure whether "video resources must embed" needs any escape hatch (e.g., videos hosted on platforms without iframe support). The wording of the rule should include an explicit fallback, e.g., "...when the hosting platform provides an iframe embed URL; otherwise, link only."

Proposed change

Edit AGENTS.md in conforma/conforma.github.io to add a short subsection (under a new or existing "Website content conventions" heading) stating: "Resource entries for videos in website/content/resources/_index.md should include an inline video embed using the {{< rawhtml >}} shortcode with an <iframe> when the hosting platform exposes an embed URL (e.g., YouTube /embed/, Google Drive /preview). Entries that link to articles or non-embeddable media may omit the embed." Optionally, add the same guidance as a short note near the top of website/content/resources/_index.md so contributors see it while editing.

Validation criteria

On the next 3 PRs that add a video-based resource entry: the initial commit includes an embed iframe (no human change-request needed to add one), and the fullsend review agent either raises no embed-related finding or, if the embed is missing, flags it at medium severity citing the new AGENTS.md rule. Track whether human reviewers still need to ask for embeds on subsequent PRs — the target is zero such asks in the next 3 video-resource PRs.


Generated by retro agent from #548

Activity

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationready-for-triageTriggers triage agent dispatchready-to-codeTriggers code agent dispatch

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions