Skip to content

docs(a11y): add API accessibility and inclusive-design guidelines - #277

Open
Ranjeet2063 wants to merge 1 commit into
Chulilee:mainfrom
Ranjeet2063:docs/api-accessibility-guidelines-196
Open

Ranjeet2063 wants to merge 1 commit into
Chulilee:mainfrom
Ranjeet2063:docs/api-accessibility-guidelines-196

Conversation

@Ranjeet2063

Copy link
Copy Markdown

Summary

Creates docs/accessibility.md with comprehensive API accessibility and inclusive-design guidelines to ensure backend semantic contracts properly support downstream assistive technologies, web/mobile frontends, and automated clients.

Changes

  • Added docs/accessibility.md covering:
    1. Scope and intent (WCAG 2.1 AA mapping to backend APIs)
    2. Structured machine-readable error responses with stable code, message, and details
    3. Status enums with human-readable display labels and severity ranking
    4. Units, currency, and numerical scale specifications
    5. Standard ISO 8601 UTC timestamps with relative labels
    6. Pagination metadata and filter query echo
    7. Notification templates with plain-text alternatives
    8. OpenAPI and Swagger UI documentation requirements
    9. Contributor and reviewer checklist
    10. Reporting process for accessibility gaps
  • Linked guidelines in README.md under Documentation.
  • Linked guidelines in CONTRIBUTING.md.
  • Added API accessibility verification to .github/PULL_REQUEST_TEMPLATE.md checklist.

Closes #196

- Create `docs/accessibility.md` defining backend API semantics for accessible downstream client interfaces
- Outline standards for machine-readable error schemas, human-readable status labels, ISO 8601 UTC timestamps, explicit currency/unit scales, and pagination metadata
- Include comprehensive API review checklist and gap reporting process
- Link guidelines in `README.md`, `CONTRIBUTING.md`, and PR checklist template

Closes Chulilee#196
Copilot AI balanced review requested due to automatic review settings October 2, 2026 20:07
@vercel

vercel Bot commented Oct 2, 2026

Copy link
Copy Markdown

@Ranjeet2063 is attempting to deploy a commit to the Akargi Team on Vercel.

A member of the Team first needs to authorize it.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

This branch has not been deployed

No deployments
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.

[A11y] Add docs/accessibility.md with API accessibility and inclusive-design guidelines

2 participants