component-driven / component-driven/cypress-axe
Documentation: missing configuration documentation
Open
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 641
- Forks
- 90
- Avg merge
- 6h 8m
- Merged PRs (30d)
- 1
Description
The MD docs point to a deque page that is broken.
This means that users are missing documentation of configuration options for both: cypress-axe and axe-core.
Below is an example (axe.configure):
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by checking the MD documentation and the linked cypress-axe README section at the provided URL, then identify where configuration options are documented for cypress-axe and axe-core. Done means the broken deque link is replaced and users can find documentation for both sets of configuration options, including an axe.configure example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100