Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add list of features to Checker ReadMe.md #955

Closed
aliunwala opened this issue Jun 7, 2022 · 4 comments · Fixed by #1230
Closed

Add list of features to Checker ReadMe.md #955

aliunwala opened this issue Jun 7, 2022 · 4 comments · Fixed by #1230
Assignees
@ErickRenteria @sct-will
Labels
documentation Improvements or additions to documentation enhancement New feature or request priority-3 (low) Ready for QA

Comments

@aliunwala
Copy link
Contributor

aliunwala commented Jun 7, 2022 •
edited by marcjohlic
Loading

Add list of features to Checker ReadMe.md

Why does this need to be accomplished

Nice list of our checker capabilities that can be used elsewhere

From the original requestor/issue:

Summary

The Repository should have a features section in the README.md, so that the users can know all the features available.

This is a Documentation request.

Justification

It is hard to know the exact features provided by the repo, which leads to a disadvantage when comparing with other accessibility solutions available.

"Must have" functionality

Documentation of the features of the project and sub-projects.

Related issues or references

See EA issue #454

image
@aliunwala aliunwala added the enhancement New feature or request label Jun 7, 2022
@aliunwala
Copy link
Contributor Author

From Triage:
See @marcjohlic 's comment above. We should just add a list of features to the readme.

@aliunwala aliunwala added the documentation Improvements or additions to documentation label Aug 4, 2022
@sct-will sct-will changed the title Add list of features to Checker ReadMe.md #3289 Add list of features to Checker ReadMe.md Dec 16, 2022
@sct-will sct-will mentioned this issue Dec 16, 2022
Closed
11 tasks
@sct-will sct-will self-assigned this Dec 16, 2022
@sct-will
Copy link
Contributor

This is in progress.

@sct-will sct-will mentioned this issue Jan 8, 2023
Closed
5 tasks
@sct-will sct-will linked a pull request Jan 8, 2023 that will close this issue
Update accessibility-checker README.md #1218
Closed
5 tasks
sct-will added a commit that referenced this issue Jan 17, 2023
@sct-will
Update feature list and highlight multi-scan in documentation
efd95bd 
– Add features list for #955 to allow users to know what the package can do for them

– Add "multi-scan" to header text to allow users to easier find documentation on multi-scan capability in #425
@sct-will sct-will mentioned this issue Jan 17, 2023
Merged
5 tasks
@sct-will
Copy link
Contributor

Updated PR here: #1230

@sct-will sct-will linked a pull request Jan 17, 2023 that will close this issue
Update feature list and highlight multi-scan in documentation #1230
Merged
5 tasks
@ErickRenteria
Copy link
Contributor

Validated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ErickRenteria ErickRenteria

@sct-will sct-will

Labels
documentation Improvements or additions to documentation enhancement New feature or request priority-3 (low) Ready for QA
Projects
None yet
Milestone
No milestone
3 participants
@aliunwala @ErickRenteria @sct-will