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 + * CatGif + * * ## Component Metadata - * [CatalogEntityCard](default:component/some-component-name) + * CatalogEntityCard * * ## System Metadata - * [CatalogEntityCard](default:system/some-system-name) + * CatalogEntityCard * ``` * * 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. `CatalogEntityCard`) and - * replace them with react portals to the addon component. + * the `` 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', }