-
-
Notifications
You must be signed in to change notification settings - Fork 4
Open
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor
Description
Description
The documentation needs accessibility improvements to ensure it's usable by everyone, including people using screen readers and other assistive technologies.
Accessibility Issues Identified
Images missing alt text descriptions- Inconsistent heading hierarchy in some documents
- Poor color contrast in some areas (if applicable)
- Missing semantic structure in some content
Tasks
### Alt Text for Images - COMPLETED
- [x] Audit all images in docs/_assets/images/
- [x] Add descriptive alt text to all images
- [x] Ensure alt text describes the content/function, not just appearance
- [x] Review image captions for clarity
Heading Structure
- Ensure proper heading hierarchy (H1 → H2 → H3, no skipping levels)
- Verify each page has only one H1
- Fix any heading level inconsistencies
- Add heading IDs where missing
Content Structure
- Review list structures for proper nesting
- Ensure tables have proper headers
- Check that links have descriptive text (avoid "click here")
Files to Focus On
- docs/_assets/images/ - All images need alt text
- Files with complex hierarchies like team role descriptions
- Process documents with multiple steps
Acceptance Criteria
- [x] All images have meaningful alt text
- Heading hierarchy is logical and consistent
- Content is screen reader friendly
- Documentation passes basic accessibility checks
- Guidelines created for future content
Resources
Metadata
Metadata
Assignees
Labels
DocsAddressing VC docsAddressing VC docsUp for GrabsAvailable for a contributorAvailable for a contributor