Add documentation

Siteimprove · Nov 29, 2024 · afd2411 · afd2411
1 parent 64593d3
commit afd2411
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 15 deletions.
diff --git a/.changeset/beige-walls-fetch.md b/.changeset/beige-walls-fetch.md
@@ -0,0 +1,5 @@
+---
+"@siteimprove/alfa-rules": minor
+---
+
+**Added:** A new experimental rule SIA-R115: "Heading is descriptive" is now available.
diff --git a/docs/review/api/alfa-rules.api.md b/docs/review/api/alfa-rules.api.md
@@ -66,12 +66,15 @@ export namespace BestPractice {
 // @public (undocumented)
 const _default: Rule.Atomic<Page, Element<string>, {}, Element<string>>;
 
-// @public @deprecated (undocumented)
-const _default_10: Rule.Atomic<Page, Text, Question.Metadata, Text>;
+// @public (undocumented)
+const _default_10: Rule.Atomic<Page, Element<string>, Question.Metadata, Element<string>>;
 
 // @public @deprecated (undocumented)
 const _default_11: Rule.Atomic<Page, Text, Question.Metadata, Text>;
 
+// @public @deprecated (undocumented)
+const _default_12: Rule.Atomic<Page, Text, Question.Metadata, Text>;
+
 // @public
 const _default_2: Rule.Atomic<Page, Document, Question.Metadata, Element<string>>;
 
@@ -84,26 +87,26 @@ const _default_4: Rule.Atomic<Page, Document, Question.Metadata, Document>;
 // @public
 const _default_5: Rule.Atomic<Page, Element<string>, Question.Metadata, Element<string>>;
 
-// @public @deprecated (undocumented)
-const _default_6: Rule.Atomic<Page, Element<string>, {}, Element<string>>;
+// @public
+const _default_6: Rule.Atomic<Page, Element<string>, Question.Metadata, Element<string>>;
 
 // @public @deprecated (undocumented)
-const _default_7: Rule.Atomic<Page, Attribute<string>, {}, Attribute<string>>;
+const _default_7: Rule.Atomic<Page, Element<string>, {}, Element<string>>;
 
-// @public (undocumented)
-const _default_8: Rule.Atomic<Page, Element<string>, Question.Metadata, Element<string>>;
+// @public @deprecated (undocumented)
+const _default_8: Rule.Atomic<Page, Attribute<string>, {}, Attribute<string>>;
 
 // @public (undocumented)
 const _default_9: Rule.Atomic<Page, Element<string>, Question.Metadata, Element<string>>;
 
 declare namespace deprecatedRules {
     export {
-        _default_6 as DR6,
-        _default_7 as DR18,
-        _default_8 as DR34,
-        _default_9 as DR36,
-        _default_10 as DR66,
-        _default_11 as DR69
+        _default_7 as DR6,
+        _default_8 as DR18,
+        _default_9 as DR34,
+        _default_10 as DR36,
+        _default_11 as DR66,
+        _default_12 as DR69
     }
 }
 export { deprecatedRules }
@@ -138,7 +141,8 @@ declare namespace experimentalRules {
         _default_2 as ER87,
         _default_3 as R82,
         _default_4 as R109,
-        _default_5 as R114
+        _default_5 as R114,
+        _default_6 as R115
     }
 }
 export { experimentalRules }
@@ -381,6 +385,10 @@ export namespace Question {
             readonly type: "boolean";
             readonly message: "Does this title describe the content of the document?";
         };
+        readonly "is-heading-descriptive": {
+            readonly type: "boolean";
+            readonly message: "Does this heading describe the following content?";
+        };
     };
         {};
 }

diff --git a/packages/alfa-rules/src/experimental.ts b/packages/alfa-rules/src/experimental.ts
@@ -4,5 +4,6 @@ import ER87 from "./sia-er87/rule.js";
 import R82 from "./sia-r82/rule.js";
 import R109 from "./sia-r109/rule.js";
 import R114 from "./sia-r114/rule.js";
+import R115 from "./sia-r115/rule.js";
 
-export { ER8, ER87, R82, R109, R114 };
+export { ER8, ER87, R82, R109, R114, R115 };