From 96655af9eeb0984fc0fc5078ac55e8a788d176a2 Mon Sep 17 00:00:00 2001
From: Michal Hitka <mhitka@ohpen.com>
Date: Wed, 31 Jan 2024 14:16:57 +0100
Subject: [PATCH] chore: document showArrowHeads in changeset

Signed-off-by: Michal Hitka <mhitka@ohpen.com>
---
 .changeset/forty-beers-sniff.md | 34 ++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

diff --git a/.changeset/forty-beers-sniff.md b/.changeset/forty-beers-sniff.md
index 6adb7e98b4..e1f478c1e1 100644
--- a/.changeset/forty-beers-sniff.md
+++ b/.changeset/forty-beers-sniff.md
@@ -3,4 +3,36 @@
 '@backstage/plugin-catalog-graph': patch
 ---
 
-Added possibility to show arrow heads for graph edges in `DependencyGraph` for better understandability.
+Added possibility to show arrow heads for graph edges for better understandability.
+
+In order to show arrow heads in the catalog graph page, add `showArrowHeads` attribute to `CatalogGraphPage` component
+(typically in `packages/app/src/App.tsx`):
+
+```diff
+  <CatalogGraphPage
+    initialState={{
+      selectedKinds: ['component', 'domain', 'system', 'api', 'group'],
+      selectedRelations: [
+        RELATION_OWNER_OF,
+        RELATION_OWNED_BY,
+        RELATION_CONSUMES_API,
+        RELATION_API_CONSUMED_BY,
+        RELATION_PROVIDES_API,
+        RELATION_API_PROVIDED_BY,
+        RELATION_HAS_PART,
+        RELATION_PART_OF,
+        RELATION_DEPENDS_ON,
+        RELATION_DEPENDENCY_OF,
+      ],
+    }}
++   showArrowHeads
+  />
+```
+
+In order to show arrow heads in entity graphs, add `showArrowHeads` attribute to `EntityCatalogGraphCard` components
+(typically multiple occurrences in `packages/app/src/components/catalog/EntityPage.tsx`):
+
+```diff
+- <EntityCatalogGraphCard variant="gridItem" height={400} />
++ <EntityCatalogGraphCard variant="gridItem" height={400} showArrowHeads />
+```