You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Remove emoji from the facilitator guide headings and fix the links to them #264
The facilitator guides start many headings with an emoji, for example ## 🎯 Quick Navigation and ## 🚀 GitHub Classroom Setup (Before Day 1). A screen reader reads the emoji's name before the heading text ("direct hit Quick Navigation", "rocket GitHub Classroom Setup"), so the headings list is noisy and every heading is harder to find by its first letter. The house style in this repository is no emoji anywhere.
The documentation accessibility check (npm run check:accessibility) counts 26 emoji in admin/FACILITATOR_GUIDE.md and 20 in admin/FACILITATOR_RESOURCES.md.
Why this is a good first issue
It is text editing only, in two files, with a clear way to check your work. No code and no accessibility expertise needed.
What to do
In admin/FACILITATOR_GUIDE.md and admin/FACILITATOR_RESOURCES.md, remove each emoji, from headings and from running text. Where an emoji carried meaning (a warning sign before "Known Gotchas"), keep the meaning in words if the words do not already say it.
Removing an emoji from a heading changes its anchor: #-github-classroom-setup-before-day-1 becomes #github-classroom-setup-before-day-1. Update every link to a changed anchor, in the same file and in the other one. FACILITATOR_RESOURCES.md links into FACILITATOR_GUIDE.md about ten times.
Update the "Section-Level Source Map" at the end of each file so its headings match.
Remove the two files' lines from scripts/docs-accessibility-baseline.json (or run node scripts/check-docs-accessibility.js --update-baseline and check that only these two files changed).
Run npm run build:html and commit the Markdown and the regenerated html/ together, as CONTRIBUTING.md describes.
Acceptance criteria
node scripts/check-docs-accessibility.js --report admin/FACILITATOR_GUIDE.md admin/FACILITATOR_RESOURCES.md reports no emoji findings.
Every in-page link and every link between the two files still lands on its heading.
npm run check:accessibility and npm run validate:authoritative-sources pass.
The other emoji the check found (admin/CURRICULUM_2.0_ORGANIZATION.md, admin/FACILITATOR_OPERATIONS.md) are a separate, later issue; leave them out of this one.
Activity
Fix documentation and site accessibility findings (#264-#268) (#271)