diff --git a/plugins/adr/README.md b/plugins/adr/README.md index a669762dad..4860406229 100644 --- a/plugins/adr/README.md +++ b/plugins/adr/README.md @@ -71,16 +71,32 @@ Afterwards, add the following code snippet to use `AdrSearchResultListItem` when import { AdrSearchResultListItem } from '@backstage/plugin-adr'; ... +, + }, + ]} +/> -case 'adr': +... + +case 'adrs': return ( ); ``` +> Note the `AdrDocument` might not be needed in newer versions https://github.com/backstage/backstage/issues/13723 + ## Custom ADR formats By default, this plugin will parse ADRs according to the format specified by the [Markdown Architecture Decision Record (MADR) v2.x template](https://github.com/adr/madr/tree/2.1.2). If your ADRs are written using a different format, you can apply the following customizations to correctly identify and parse your documents: