docs(#566): document video embed convention for resource entries - #567
fullsend-ai-coder[bot] wants to merge 1 commit into
Conversation
Add AGENTS.md at the repo root with a "Website content conventions"
section stating that resource entries in
website/content/resources/_index.md which link to a video must embed
the player inline via the {{< rawhtml >}} shortcode with an <iframe>
when the hosting platform exposes an embed URL (YouTube /embed/,
Google Drive /preview). Article-only entries and media with no
embeddable player are exempt.
The convention already holds for the existing entries in _index.md
(five YouTube iframe embeds, one Google Drive preview, one FOSDEM
<video> tag) but was not written down anywhere the review agent
could cite, leading to a soft "low" finding on PR #548 that a human
reviewer then upgraded to a change request. Recording the rule here
gives future review runs a firm anchor.
Closes #566
|
Important Review skippedBot user detected. To trigger a single review, invoke the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
|
🤖 Finished Review · ✅ Success · Started 7:05 AM UTC · Completed 7:16 AM UTC Commit: Runtime: claude · Model: opus → claude-opus-4-7 · Effort: high · Cost: $5.48 |
|
🚀 Preview is available at https://2b69a1e6.enterprise-contract.pages.dev |
|
Risk Assessment: moderate (2/5) DetailsTiny docs-only addition by a bot with matching issue scope; edits one protected path (AGENTS.md itself), which elevates Tier 1 above a pure typo-fix baseline and yields a weighted composite of ~1.5, rounding to moderate. |
ReviewFindingsMedium
Next steps:
|
![fullsend-ai-review[bot]](https://avatars.githubusercontent.com/in/3478501?s=60&v=4){kind=small}
| Repository conventions for AI coding agents and human contributors. | ||
|
|
||
| ## Website content conventions | ||
|
|
There was a problem hiding this comment.
[medium] docs-currency
AGENTS.md prescribes exactly one embed shape: {{< rawhtml >}} + <iframe> when the hosting platform exposes an embed URL, with a fallback that only covers 'media with no embeddable player.' However, website/content/resources/_index.md lines 66-75 (the FOSDEM entry 'From Passive Data to Active Defense') embeds the video with an HTML5 <video> element and <source> tags pointing at direct .webm/.mp4 files, because FOSDEM publishes downloadable video files rather than an iframe embed URL. Under the new rule this entry falls into an undocumented gap: it is neither an iframe-embeddable player nor 'media with no embeddable player'. An agent following AGENTS.md literally would either try to convert it to an iframe (which FOSDEM doesn't offer) or drop the inline embed.
Suggested fix: Extend the rule to cover the <video>-with-<source> pattern, e.g., 'use <iframe> inside {{< rawhtml >}} when the platform exposes an embed URL; use a <video> element with <source> children when only direct media files (e.g., FOSDEM .webm/.mp4) are available; entries linking to articles or to media with no playable source may omit the embed.'
Summary
Adds an
AGENTS.mdfile at the repo root documenting the resourcespage's embedded-video convention: entries in
website/content/resources/_index.mdthat link to a video must embedthe player inline via the
{{< rawhtml >}}shortcode with an<iframe>when the hosting platform exposes an embed URL (YouTube/embed/, Google Drive/preview). Article-only entries and mediawith no embeddable player are exempt.
Motivation
On #548 the initial commit for the Red Hat Summit 2026 demo did not
embed a video player. The review agent flagged the missing embed at
low severity — softening it because a prior article-only entry also
lacked an embed — and a human maintainer then had to change-request
the addition. The convention is already followed everywhere else on
the resources page (five YouTube iframes, one Google Drive preview,
one FOSDEM
<video>tag) but was not written down. Recording it inAGENTS.mdgives the review agent an anchor to raise a missingembed to at least medium severity in future PRs, and tells human
contributors what to include on first push.
Notes
AGENTS.mddoes not exist in the repository today, so this PRcreates it. Only the website content convention is included — no
unrelated agent guidance was added.
resource entry is left as-is; the fallback clause in the rule
explicitly covers it.
future video-resource PRs per the acceptance criteria in the
issue.
Closes #566
Post-script verification
agent/566-document-video-embed-convention)e34320da46a2afbb6f7b1cee2afcb7954944498a..HEAD)