From f7ecdbb3977d96a7849578304847e953be18223b Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Mon, 11 Jan 2021 22:39:05 +0100 Subject: [PATCH] changeset: Info about techdocs generator api change --- .changeset/eleven-badgers-wink.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/.changeset/eleven-badgers-wink.md b/.changeset/eleven-badgers-wink.md index 1d0c1443fb..a08c11d257 100644 --- a/.changeset/eleven-badgers-wink.md +++ b/.changeset/eleven-badgers-wink.md @@ -1,6 +1,9 @@ --- '@backstage/techdocs-common': patch +'@backstage/plugin-techdocs-backend': patch --- -Improve techdocs-common Generator API for it to be used by techdocs-cli. No breaking changes. -Generator can now accept an output directory. +Improve techdocs-common Generator API for it to be used by techdocs-cli. TechDocs generator.run function now takes +an input AND an output directory. Most probably you use techdocs-common via plugin-techdocs-backend, and so there +is no breaking change for you. +But if you use techdocs-common separately, you need to create an output directory and pass into the generator.