openedx / openedx/paragon

[paragon-openedx.netlify.app] Feedback (on /components/form/form-label/)

Open
#2,665 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

docs
Dominant language
JavaScript
Stars
140
Forks
100
Avg merge
1h 3m
Merged PRs (30d)
30

Description

Feedback summary

### Tasks
- [ ] Consider including `aria-label` documentation on `Form.Label` docs page (https://paragon-openedx.netlify.app/components/form/form-label/), and/or elsewhere. I.e., if your use case doesn't call for visually displayed label, should use `aria-label` or `aria-labelledby`.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the Form.Label documentation at /components/form/form-label/ and locate its source documentation in the repository. Update the relevant documentation to explain when to use aria-label or aria-labelledby instead of a visually displayed label, then verify the rendered docs page communicates this guidance clearly.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.