AllyProof/Docs
Log InGet Started

Quick Start

Get from signup to your first scan results in under 5 minutes.

1. Create Your Account

Sign up at /signup with email/password or Google OAuth. A personal organization is created automatically on signup.

2. Add a Site

Go to Sites and click Add Site. Enter the URL and choose a verification method (DNS TXT record or HTML meta tag).

3. Verify Ownership

Follow the verification instructions shown on the site detail page. For DNS verification, add a TXT record to your domain. For meta tag verification, add a meta tag to your homepage. Click Verify when done.

4. Run Your First Scan

Once verified, click Scan Now. The scan will:

  1. Discover pages via your sitemap (or crawl the homepage for links)
  2. Scan each page with axe-core + HTML_CodeSniffer + APCA contrast
  3. Store deduplicated violations with severity ratings
  4. Generate AI fix suggestions (if ANTHROPIC_API_KEY is configured)

Scan progress is shown in real-time. Results appear on the site detail page when complete.

5. Review Results

After scanning, you can:

  • View the accessibility score and violation summary on the site detail page
  • Browse all violations in the Issues page with filters for severity, status, and site
  • Click any violation to see affected elements, code snippets with syntax highlighting, and AI fix suggestions
  • Mark violations as resolved, in progress, or false positive
  • Export violations as CSV

6. Generate Reports

From the site detail page, click Publish Statement to create a public accessibility statement, or go to Reports to generate a VPAT document.

Next Steps