From 03843259b4941b727ffaf07886865617e8076ee6 Mon Sep 17 00:00:00 2001 From: Juan Pablo Garcia Ripa Date: Mon, 28 Nov 2022 20:58:51 +0100 Subject: [PATCH] add changeset and prettier Signed-off-by: Juan Pablo Garcia Ripa --- .changeset/slow-eggs-grab.md | 8 ++++++++ .changeset/warm-parents-notice.md | 5 +++++ .../repo-tools/src/commands/api-reports/api-extractor.ts | 2 +- 3 files changed, 14 insertions(+), 1 deletion(-) create mode 100644 .changeset/slow-eggs-grab.md create mode 100644 .changeset/warm-parents-notice.md diff --git a/.changeset/slow-eggs-grab.md b/.changeset/slow-eggs-grab.md new file mode 100644 index 0000000000..e4c537687f --- /dev/null +++ b/.changeset/slow-eggs-grab.md @@ -0,0 +1,8 @@ +--- +'@backstage/repo-tools': minor +--- + +Api reference documentation improvements + +- breadcrumbs links semantics as code spans +- new `@config` annotation to describe related config keys diff --git a/.changeset/warm-parents-notice.md b/.changeset/warm-parents-notice.md new file mode 100644 index 0000000000..9ea14e2068 --- /dev/null +++ b/.changeset/warm-parents-notice.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-proxy-backend': patch +--- + +Add documentation to de api reference diff --git a/packages/repo-tools/src/commands/api-reports/api-extractor.ts b/packages/repo-tools/src/commands/api-reports/api-extractor.ts index 2b130f50e0..bae62ccc7e 100644 --- a/packages/repo-tools/src/commands/api-reports/api-extractor.ts +++ b/packages/repo-tools/src/commands/api-reports/api-extractor.ts @@ -1037,7 +1037,7 @@ export async function buildDocs({ configuration, text: ' > ', }), - new DocCodeSpanLink({ + new DocCodeSpanLink({ configuration, tagName: '@link', linkText: hierarchyItem.displayName,