Skip to content

Add alt text guidance to the style guide - #2218

Merged
cderv merged 2 commits into
mainfrom
docs/alt-text-style-guide
Sep 29, 2026
Merged

cderv merged 2 commits into
mainfrom
docs/alt-text-style-guide

Conversation

@cwickham

Copy link
Copy Markdown
Member

Adds an "Images and Alt Text" section to _style-guide.md. The section has the rules that the recent alt text PRs used (#2138, #2195, #2199, #2203, #2206, #2210, #2211, #2213, #2217). New images can then get correct alt text when someone adds them.

Also adds .claude/rules/images-alt-text.md, a short form of the section. Claude Code loads this file when it edits a .qmd file or a .md file in docs/.

@cwickham
cwickham marked this pull request as ready for review September 25, 2026 19:35
@cwickham
cwickham requested a review from cderv September 25, 2026 19:35
@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2218.quarto.org

@cwickham

Copy link
Copy Markdown
Member Author

@cderv assigned a review to get your eyes on this. I'm happy with the content, I'm interested in your view on whether this split between rules/ and _style-guide.md is right.

@cderv cderv left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is good split yes.

Currently, I am learning more and experimenting with less context rules and more skills. So I wonder if we need a /quarto-alt-text or mor generic /alt-text skills like https://github.com/posit-dev/skills/tree/main/alt-text

Or maybe /style-guide should be the skill.

Anyhow, I think this is ok. We could try evaluate if this is working using evals in session using this PR rule, and other using default rules.

Did you try comparing ?

We can see at usage too.

Comment thread .claude/rules/images-alt-text.md
Comment thread _style-guide.md
@github-actions

Copy link
Copy Markdown
Contributor

📝 Preview Deployment

🔍 Full site preview: https://deploy-preview-2218.quarto.org

@cderv
cderv merged commit 4b057f9 into main Sep 29, 2026
3 checks passed
@cderv
cderv deleted the docs/alt-text-style-guide branch September 29, 2026 10:47
@github-actions

Copy link
Copy Markdown
Contributor

Successfully created backport PR for prerelease:

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants