Presentation: Common rule docs (#3186)

* Add `chai-string` dependency to presentation-full-stack-tests * Doc enhancements for `RelatedInstanceSpecification` * Doc enhancements for `RelationshipPathSpecification` * Add docs for `RepeatableRelationshipPathSpecification` * Move `MultiSchemaClasses` learning snippet test into `CommonRules.test.ts`. Add a result image for it. * Move common rule docs into presentation docs root to avoid having to provide an index for them * Update docs/presentation/RelatedInstanceSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Update docs/presentation/RelatedInstanceSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Remove unused `chai-string` dependency * Update full-stack-tests/presentation/src/learning-snippets/CommonRules.test.ts Co-authored-by: Robert Lukasonok <[email protected]> * Extend the recursive relationship step step example * Attempt to clarify `count: "*"` * Restore unintentional changes * Restore unintentional changes * Update docs/presentation/RepeatableRelationshipPathSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Update docs/presentation/RepeatableRelationshipPathSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Update docs/presentation/RepeatableRelationshipPathSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Update docs/presentation/RepeatableRelationshipPathSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> * Update docs/presentation/RepeatableRelationshipPathSpecification.md Co-authored-by: Robert Lukasonok <[email protected]> Co-authored-by: Robert Lukasonok <[email protected]>
iTwin · Mar 3, 2022 · 7890b9d · 7890b9d
1 parent 6cf0a26
commit 7890b9d
Show file tree

Hide file tree

Showing 45 changed files with 892 additions and 323 deletions.
diff --git a/...on/changes/@itwin/presentation-common/presentation-common-rule-docs_2022-03-03-11-17.json b/...on/changes/@itwin/presentation-common/presentation-common-rule-docs_2022-03-03-11-17.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/presentation-common",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/presentation-common"
+}
diff --git a/docs/changehistory/2.11.0.md b/docs/changehistory/2.11.0.md
@@ -296,7 +296,7 @@ A property value renderer for instance key values has been added, which allows u
 
 ### Breaking changes to `ContentRelatedInstances`
 
-Behavior of `ContentRelatedInstances` specification used in content rules was changed. It used to include input instances into the result if all paths in `relationshipPaths` property had `count: "*"` and target class matched input instance class. The behavior was changed to match cases where steps `relationshipPaths` have `count` set to specific number - the result only includes instances resulting from step outputs. See [RelationshipPathSpecification documentation]($docs/presentation/Common-Rules/RelationshipPathSpecification.md) for more details and examples.
+Behavior of `ContentRelatedInstances` specification used in content rules was changed. It used to include input instances into the result if all paths in `relationshipPaths` property had `count: "*"` and target class matched input instance class. The behavior was changed to match cases where steps `relationshipPaths` have `count` set to specific number - the result only includes instances resulting from step outputs. See [RelationshipPathSpecification documentation]($docs/presentation/RelationshipPathSpecification.md) for more details and examples.
 
 Example:
 

diff --git a/docs/presentation/Common-Rules/RelatedInstanceSpecification.md b/docs/presentation/Common-Rules/RelatedInstanceSpecification.md
diff --git a/docs/presentation/Common-Rules/RelationshipPathSpecification.md b/docs/presentation/Common-Rules/RelationshipPathSpecification.md