Adds video guidance to syntax ref guide

[jmikell821]

Resolves elastic/docs-content#5626 by adding guidance on how to add videos to docs.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 72fa0c30-5c84-47e6-b1e4-7cf4268337d4

📥 Commits

Reviewing files that changed from the base of the PR and between 4ced702 and 3a126e0.

📒 Files selected for processing (1)

• docs/syntax/videos.md

✅ Files skipped from review due to trivial changes (1)

• docs/syntax/videos.md

---

📝 Walkthrough

Walkthrough

This pull request adds a new documentation page, docs/syntax/videos.md, and registers it in the docs table of contents (docs/_docset.yml). The new page documents how to embed and link videos, covering Elastic-hosted thumbnail links, YouTube embeds, a best-practices checklist, example Markdown snippets, and a note that video URLs must use lowercase characters for docs-builder compatibility.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Adds video guidance to syntax ref guide' directly and clearly describes the main change: adding documentation about how to incorporate videos.
Description check	✅ Passed	The description references the resolved issue and clearly states the purpose: adding guidance on how to add videos to docs.
Linked Issues check	✅ Passed	The PR adds a new docs/syntax/videos.md file with guidance on embedding and linking videos, directly addressing issue #5626's requirement for video incorporation guidance in the syntax reference.
Out of Scope Changes check	✅ Passed	All changes are in scope: the new videos.md file and the docset.yml entry are directly related to adding video guidance as specified in issue #5626.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

✨ Simplify code

• Create PR with simplified code
• Commit simplified code in branch issue-5626

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

• Generate code and open pull requests
• Plan features and break down work
• Investigate incidents and troubleshoot customer tickets together
• Automate recurring tasks and respond to alerts with triggers
• Summarize progress and report instantly

Built for teams:

• Shared memory across your entire org—no repeating context
• Per-thread sandboxes to safely plan and execute work
• Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/syntax/videos.md`:
- Line 6: The Elastic-hosted example contradicts the "Video link URLs must use
lowercase characters only" rule by using a mixed-case ID in the example URLs;
update the Elastic example so both video link URLs use the lowercase-only ID
(replace the mixed-case ID with its lowercase equivalent in the Elastic-hosted
example) so the guidance and example are consistent.
- Line 53: Update the checklist entry that currently reads "Use lowercase
characters in all video URLs" so it only applies to Elastic/integrations style
paths (e.g., URLs containing "elastic" or "/integrations/") and not to external
provider IDs like YouTube video IDs; change the sentence to explicitly scope
lowercase requirement to Elastic/integrations URL pattern and add a note that
provider IDs (e.g., YouTube IDs) must be left case-sensitive. Also adjust the
related duplicate instances of that checklist text so they match the new scoped
wording.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 17ab26ba-50e3-43af-9a9c-2560dbb20f0e

📥 Commits

Reviewing files that changed from the base of the PR and between b31505c and 4ced702.

📒 Files selected for processing (2)

• docs/_docset.yml
• docs/syntax/videos.md

[benironside]

LGTM, syntax is familiar. Not blocking, but the callout about the lowercase URLs is interesting. I haven't tested it but I think making clear exactly what happens with integrations docs if we use video URLs with mixed cases would be helpful.