From 1f51e960afc984a29140515bdbd969430c49216e Mon Sep 17 00:00:00 2001
From: Otto Sichert <git@ottosichert.de>
Date: Tue, 12 Apr 2022 11:11:04 +0200
Subject: [PATCH] Update draft comment for COMPONENT TechDocs location
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Co-authored-by: Anders Näsman <realandersn@users.noreply.github.com>
Co-authored-by: Eric Peterson <iamEAP@users.noreply.github.com>
Signed-off-by: Otto Sichert <git@ottosichert.de>
---
 plugins/techdocs-react/src/types.ts | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/plugins/techdocs-react/src/types.ts b/plugins/techdocs-react/src/types.ts
index a69c98462c..87dd9687da 100644
--- a/plugins/techdocs-react/src/types.ts
+++ b/plugins/techdocs-react/src/types.ts
@@ -76,11 +76,14 @@ export enum TechDocsAddonLocations {
    * attributes provided on that element, for example:
    *
    * ```md
+   * ## For Fun
+   * <TechDocsAddon>CatGif</TechDocsAddon>
+   *
    * ## Component Metadata
-   * [CatalogEntityCard](default:component/some-component-name)
+   * <TechDocsAddon entityRef="default:component/some-component-name">CatalogEntityCard</TechDocsAddon>
    *
    * ## System Metadata
-   * [CatalogEntityCard](default:system/some-system-name)
+   * <TechDocsAddon entityRef="default:system/some-system-name">CatalogEntityCard</TechDocsAddon>
    * ```
    *
    * Could correspond to a TechDocs addon named `CatalogEntityCard` with
@@ -90,8 +93,9 @@ export enum TechDocsAddonLocations {
    *
    * The `@backstage/plugin-techdocs-react` package would need to be updated to, in
    * cases where such addons had been registered, find all instances of the
-   * rendered markdown (e.g. `<a href="{entityRef}">CatalogEntityCard</a>`) and
-   * replace them with react portals to the addon component.
+   * the `<TechDocsAddon>` tag whose `textContent` corresponded with the name of the
+   * addon, then replace them with component instances of the addon component,
+   * passing any attributes from the tag as props to the component.
    */
   // COMPONENT = 'component',
 }