Skip to content

Describe more about how this could be useful for other tools #9

@mgifford

Description

@mgifford

I think that this should be something that could be applied more consistently to other tools. I've got a few as you know that might benefit from having some basic suggestions to start with.

I wondered if having more extensive descriptions in the README.md file here might help. It would be good to know what it does and what (if any) contributions you might appreciate. I just got AI to draft this:


The purple-ai repository, created by GovTech Singapore, is a specialized database designed to help web developers fix "accessibility" issues on their websites using Artificial Intelligence.

In plain language, "web accessibility" means making sure a website works well for everyone, including people who are blind, have low vision, or have other disabilities.

What does it do?

When developers build websites, they sometimes make technical mistakes—like forgetting to describe an image for a screen reader or making a button that can't be clicked using a keyboard.

This repository acts as a smart library of solutions. It contains a large collection of accessibility problems paired with AI-generated fixes (originally from GPT-3.5 and now updated with Meta’s Llama 3 models).

Instead of a developer having to guess how to fix a complex code error, they can refer to this repository to see:

  1. The Issue: What is wrong with the code.
  2. The Fix: Exactly how the code should be rewritten to be accessible.

How might someone use it?

Most people won't use this repository directly by reading the code files. Instead, it is typically used in two ways:

  1. Integration into Testing Tools: The primary way to use this is through GovTech's main accessibility tool called Oobee (formerly known as Purple A11y). When Oobee scans a website and finds an error, it pulls a "fix" from this purple-ai database to show the developer exactly how to solve it.

  2. As a Reference for AI Training: If you are a developer building your own internal tools, you might use this data to "teach" an AI how to recognize and fix web accessibility bugs specifically for your organization's coding style.

Why is it useful?

  • Plain English Explanations: It translates technical jargon into easy-to-understand instructions.
  • Faster Fixing: Developers spend less time searching through manuals (like the WCAG standards) and more time actually fixing their apps.
  • Consistency: It ensures that every developer on a team fixes the same problem in the same high-quality way.

In short: It is a "cheat sheet" powered by AI that teaches developers how to build digital services that everyone, regardless of their physical abilities, can use.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions