Skip to content

Fix grammar in project card alt text#568

Open
eloi-web wants to merge 6 commits into
firstcontributions:mainfrom
eloi-web:fix-typo-readme
Open

Fix grammar in project card alt text#568
eloi-web wants to merge 6 commits into
firstcontributions:mainfrom
eloi-web:fix-typo-readme

Conversation

@eloi-web
Copy link
Copy Markdown

This updates one alt text string for clarity and accessibility.

@Sean-Kenneth-Doherty
Copy link
Copy Markdown

I tested this locally. The branch builds, but I think the accessibility improvement should go a bit further before merge.

Checks run:

  • git diff --check main...HEAD passes
  • pnpm build passes
  • inspected built dist/index.html

The grammar fix is correct, but the generated page still renders the exact same alt text on all 152 project logos: The framework or language that the project is built upon. That is better grammar, but still generic and not very useful to screen-reader users or SEO crawlers. Since ProjectCard.astro already has the project name, a more useful alt would be project-specific, for example alt={${name} logo}.

Also, please remove the generated .astro/* files from the PR; the source fix only needs src/components/ProjectCard.astro.

@Sean-Kenneth-Doherty
Copy link
Copy Markdown

Thanks for fixing the typo. One blocker: the PR also updates generated .astro files (.astro/data-store.json, .astro/settings.json, .astro/types.d.ts). Those should be removed so the PR only changes source. While touching this alt text, I would also make it project-specific rather than another generic sentence, for example by using the project name in ProjectCard so screen readers hear the actual logo context.

Copy link
Copy Markdown
Author

@eloi-web eloi-web left a comment

Choose a reason for hiding this comment

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

I have reviewed all the suggested changes and fixed them.

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