Alt text requirement not documented clearly
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 467
- Forks
- 65
- PR merge metrics
- No merged PRs in 30d
Description
As a beginner using Eleventy (having forked the base-blog repo) I spent a long time trying to debug why my images were being rendered to the site with the wrong paths, failing to realise that they would render correctly if I added alt text.
Afterwards I noticed that it is mentioned only way down in the description for htmlOptions as a single line commented '// required'.
Have I understood the issue correctly? If so, how can the requirement be documented more clearly? I also think an error or warning message should be printed to notify the user when the alt text is missing and why this leads to a broken image.
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
Start with the Image plugin documentation at the linked return-type-and-html-options section, especially the htmlOptions description and its alt-text requirement. Confirm how missing alt text currently affects image paths, then document the requirement prominently and define the expected warning or error behavior for missing alt text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100