Closed chmst closed 3 months ago
PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.
β±οΈ Estimated effort to review: 2 π΅π΅βͺβͺβͺ |
π§ͺ No relevant tests |
π No security concerns identified |
β‘ Key issues to review Typographical Errors There are several typographical errors in the added content, such as "infomation" should be "information", "accessibilty" should be "accessibility", and "Detailled" should be "Detailed". Code Snippet Language The language specified in the code snippets is 'PHPx', which might be incorrect or non-standard. Consider using 'php' if these are PHP code snippets. |
PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.
Category | Suggestion | Score |
Maintainability |
Correct spelling mistakes to enhance document professionalism___ **Correct the spelling mistake in 'infomation' to 'information'.** [docs/accessibility/index.md [13]](https://github.com/joomla/Manual/pull/285/files#diff-e5da3514ace90509b1f0f5eaf2355bd25bb404c0b223cda67aa028230b5968f7R13-R13) ```diff -The infomation in this chapter enables extension and template developers adapting or writing code and keep accessibilty over the whole site. +The information in this chapter enables extension and template developers adapting or writing code and keep accessibility over the whole site. ``` - [ ] **Apply this suggestion**Suggestion importance[1-10]: 10Why: Correcting spelling mistakes is crucial for maintaining professionalism and clarity in documentation. | 10 |
Accessibility |
Add descriptive alt-text to images for better accessibility___ **Add alt-text for images to follow accessibility guidelines and provide context forscreen readers.** [versioned_docs/version-5.1/accessibility/element-library/tooltip.md [51]](https://github.com/joomla/Manual/pull/285/files#diff-e917ae578c9ba1e1fc28352a372b36e856a21608f39f578523fba8b6738b449eR51-R51) ```diff -![A tooltip indicates the unpublish action on the state button](image.png) +![A tooltip indicates the unpublish action on the state button](image.png "Unpublish action tooltip") ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 10Why: Adding alt-text to images is essential for accessibility, ensuring that screen readers can provide context to visually impaired users. | 10 |
Enhancement |
Convert plain URLs to Markdown links for better readability___ **Replace the plain URL with a Markdown link to improve readability and userexperience.** [docs/accessibility/index.md [8]](https://github.com/joomla/Manual/pull/285/files#diff-e5da3514ace90509b1f0f5eaf2355bd25bb404c0b223cda67aa028230b5968f7R8-R8) ```diff -Find here Joomla's accessibility Statement https://www.joomla.org/accessibility-statement.html. +Find here Joomla's accessibility Statement [here](https://www.joomla.org/accessibility-statement.html). ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 9Why: The suggestion improves readability and user experience by converting plain URLs to Markdown links, which is a best practice in documentation. | 9 |
Best practice |
Clarify how to make tooltips dismissible to comply with accessibility standards___ **Ensure that the tooltip text is dismissible and does not disappear automatically byadding a clear example or guideline.** [versioned_docs/version-5.1/accessibility/element-library/tooltip.md [16]](https://github.com/joomla/Manual/pull/285/files#diff-e917ae578c9ba1e1fc28352a372b36e856a21608f39f578523fba8b6738b449eR16-R16) ```diff -The tooltip must be dismissible, cannot disappear automatically. +Ensure that tooltips are dismissible and do not disappear automatically. For example, add a close button or allow dismissal through keyboard interactions. ``` - [ ] **Apply this suggestion** Suggestion importance[1-10]: 8Why: The suggestion provides a clear guideline on how to make tooltips dismissible, which is important for accessibility compliance. | 8 |
In general please don't edit old versions only edit /docs, afterwards we (you, me anyone else) can backport it older versions.
Also I'm a bit confused you added a template (which shouldn't be at this place) but then don't use it? is that expected?
I think also it's important to explain some basics of a11y, I know that topic is really complex but there are low hanging fruits which many developers or designers fails on which can easily be solved. Like contrasts or Link text, and size, nothing special but just to give a show introduction why things are how they are.
Also please follow the coding guide for the Documention, we don't allow more then one h1 in the documentation which is actually the first headline with is unterlined with =. All other Headline starts with at least 2 #.
User description
The part of Accessibility was started big, but we cannot do all this work. It seems better to reduce it all. We should build a library of Code snippets, as we use in Core files, enabling extension developers to see why and how we build accessible views.
@HLeithner this PR is made in version 5.1. Not sure if it is correct with deleting files and folders.
PR Type
Documentation, Enhancement
Description
Changes walkthrough π
13 files
index.md
Enhance accessibility documentation with additional resources and
structure
docs/accessibility/index.md
reading.
atag.md
Remove incomplete ATAG conformance documentation
versioned_docs/version-5.1/accessibility/atag.md - Removed unfinished ATAG conformance documentation.
empty-template.md
Remove empty template for best practices
versioned_docs/version-5.1/accessibility/best-practices/empty-template.md - Deleted empty template for best practices documentation.
index.md
Remove placeholder for best practices documentation
versioned_docs/version-5.1/accessibility/best-practices/index.md - Removed placeholder for best practices documentation.
tooltip.md
Remove unfinished tooltip best practices documentation
versioned_docs/version-5.1/accessibility/best-practices/tooltip.md - Deleted unfinished tooltip best practices documentation.
code-for-humans.md
Remove unfinished "code for humans" documentation
versioned_docs/version-5.1/accessibility/code-for-humans.md - Removed unfinished "code for humans" documentation.
index.md
Minor formatting changes to accessible UI library documentation
versioned_docs/version-5.1/accessibility/element-library/index.md - Minor formatting changes to accessible UI library documentation.
tooltip.md
Add detailed tooltip best practices documentation
versioned_docs/version-5.1/accessibility/element-library/tooltip.md
further-reading.md
Remove placeholder for further reading section
versioned_docs/version-5.1/accessibility/further-reading.md - Removed placeholder for further reading section.
index.md
Enhance accessibility documentation with additional resources and
structure
versioned_docs/version-5.1/accessibility/index.md
reading.
reporting-issues.md
Remove unfinished reporting issues documentation
versioned_docs/version-5.1/accessibility/reporting-issues.md - Removed unfinished reporting issues documentation.
testing.md
Remove unfinished testing accessibility documentation
versioned_docs/version-5.1/accessibility/testing.md - Removed unfinished testing accessibility documentation.
wcag.md
Remove unfinished WCAG conformance documentation
versioned_docs/version-5.1/accessibility/wcag.md - Removed unfinished WCAG conformance documentation.