Add readme and docs

sidhsharma1992 · sidhsharma1992 · commit 3dce7d15bfc9 · 2025-09-19T13:02:14.000-04:00
diff --git a/README.md b/README.md
@@ -183,6 +183,7 @@ Any use of third-party trademarks or logos are subject to those third-party's po
 | [combobox-needs-labelling](docs/rules/combobox-needs-labelling.md)                                                     | All interactive elements must have an accessible name                                                                                                                        | ✅  |    |    |
 | [compound-button-needs-labelling](docs/rules/compound-button-needs-labelling.md)                                       | Accessibility: Compound buttons must have accessible labelling: title, aria-label, aria-labelledby, aria-describedby                                                         | ✅  |    |    |
 | [counter-badge-needs-count](docs/rules/counter-badge-needs-count.md)                                                   |                                                                                                                                                                              | ✅  |    | 🔧 |
+| [datagrid-needs-labelling](docs/rules/datagrid-needs-labelling.md)                                                     | Accessibility: DataGrid must have proper labelling and follow ARIA grid patterns for complex data tables                                                                     | ✅  |    |    |
 | [dialogbody-needs-title-content-and-actions](docs/rules/dialogbody-needs-title-content-and-actions.md)                 | A DialogBody should have a header(DialogTitle), content(DialogContent), and footer(DialogActions)                                                                            | ✅  |    |    |
 | [dialogsurface-needs-aria](docs/rules/dialogsurface-needs-aria.md)                                                     | DialogueSurface need accessible labelling: aria-describedby on DialogueSurface and aria-label or aria-labelledby(if DialogueTitle is missing)                                | ✅  |    |    |
 | [dropdown-needs-labelling](docs/rules/dropdown-needs-labelling.md)                                                     | Accessibility: Dropdown menu must have an id and it needs to be linked via htmlFor of a Label                                                                                | ✅  |    |    |
@@ -206,11 +207,13 @@ Any use of third-party trademarks or logos are subject to those third-party's po
 | [spin-button-unrecommended-labelling](docs/rules/spin-button-unrecommended-labelling.md)                               | Accessibility: Unrecommended accessibility labelling - SpinButton                                                                                                            | ✅  |    |    |
 | [spinner-needs-labelling](docs/rules/spinner-needs-labelling.md)                                                       | Accessibility: Spinner must have either aria-label or label, aria-live and aria-busy attributes                                                                              | ✅  |    |    |
 | [switch-needs-labelling](docs/rules/switch-needs-labelling.md)                                                         | Accessibility: Switch must have an accessible label                                                                                                                          | ✅  |    |    |
+| [table-needs-labelling](docs/rules/table-needs-labelling.md)                                                           | Accessibility: Table must have proper labelling and semantic structure for screen readers                                                                                    | ✅  |    |    |
 | [tablist-and-tabs-need-labelling](docs/rules/tablist-and-tabs-need-labelling.md)                                       | This rule aims to ensure that Tabs with icons but no text labels have an accessible name and that Tablist is properly labeled.                                               | ✅  |    |    |
 | [tag-dismissible-needs-labelling](docs/rules/tag-dismissible-needs-labelling.md)                                       | This rule aims to ensure that dismissible Tag components have proper accessibility labelling: either aria-label on dismissIcon or aria-label on Tag with role on dismissIcon | ✅  |    |    |
 | [tag-needs-name](docs/rules/tag-needs-name.md)                                                                         | Accessibility: Tag must have an accessible name                                                                                                                              | ✅  |    |    |
 | [toolbar-missing-aria](docs/rules/toolbar-missing-aria.md)                                                             | Accessibility: Toolbars need accessible labelling: aria-label or aria-labelledby                                                                                             | ✅  |    |    |
 | [tooltip-not-recommended](docs/rules/tooltip-not-recommended.md)                                                       | Accessibility: Prefer text content or aria over a tooltip for these components MenuItem, SpinButton                                                                          | ✅  |    |    |
+| [tree-needs-labelling](docs/rules/tree-needs-labelling.md)                                                             | Accessibility: Tree must have proper labelling and follow ARIA tree pattern for hierarchical navigation                                                                      | ✅  |    |    |
 | [visual-label-better-than-aria-suggestion](docs/rules/visual-label-better-than-aria-suggestion.md)                     | Visual label is better than an aria-label because sighted users can't read the aria-label text.                                                                              |    | ✅  |    |
 
 <!-- end auto-generated rules list -->
diff --git a/docs/rules/datagrid-needs-labelling.md b/docs/rules/datagrid-needs-labelling.md
@@ -1,4 +1,8 @@
-# datagrid-needs-labelling
+# Accessibility: DataGrid must have proper labelling and follow ARIA grid patterns for complex data tables (`@microsoft/fluentui-jsx-a11y/datagrid-needs-labelling`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 DataGrid components must have accessible labelling for screen readers to understand the data structure and purpose.
 
diff --git a/docs/rules/table-needs-labelling.md b/docs/rules/table-needs-labelling.md
@@ -1,4 +1,8 @@
-# table-needs-labelling
+# Accessibility: Table must have proper labelling and semantic structure for screen readers (`@microsoft/fluentui-jsx-a11y/table-needs-labelling`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 Table components must have accessible labelling for screen readers to understand the table's purpose and content structure.
 
diff --git a/docs/rules/tree-needs-labelling.md b/docs/rules/tree-needs-labelling.md
@@ -1,4 +1,8 @@
-# tree-needs-labelling
+# Accessibility: Tree must have proper labelling and follow ARIA tree pattern for hierarchical navigation (`@microsoft/fluentui-jsx-a11y/tree-needs-labelling`)
+
+💼 This rule is enabled in the ✅ `recommended` config.
+
+<!-- end auto-generated rule header -->
 
 Tree components must have accessible labelling for screen readers to understand the hierarchical structure and navigation purpose.
 
