components-web-app / components-web-app/docs
Docs: add video placeholder callouts in step-by-step guide sections
Nobody has claimed this yet.
- Dominant language
- Vue
- Stars
- 0
- Forks
- 0
- PR merge metrics
- No merged PRs in 30d
Description
Task
At natural "try it now" moments in the guides — particularly in your-first-component Step 5 and similar step-by-step sections — add placeholder callouts for short walkthrough videos.
These placeholders should describe what the video would show, making it easy to know what to record.
Example format
::placeholder-video{label="VIDEO: Adding a Title component in edit mode, typing in the admin tab, watching it update live"}
::
Idea from internal docs review (nice-to-have).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the step-by-step guide sections, starting with your-first-component Step 5, and identify natural “try it now” moments. Add descriptive placeholder-video callouts using the format shown in the issue, covering what each walkthrough would show. Done means the relevant guide sections contain clear recording briefs without changing the surrounding instructions.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100