From 41b65b190e44642292a8f3b8c6858f7c682ad705 Mon Sep 17 00:00:00 2001 From: Eva Gustavsson Date: Fri, 8 May 2026 16:22:56 +0200 Subject: [PATCH] fix: Correct faulty link to techdocs-cli (#34091) The link to Github repository of techdocs-cli was faulty. This commit corrects the link in the documentation. Signed-off-by: evhnn29 --- docs/contribute/project-structure.md | 2 +- docs/features/techdocs/architecture.md | 2 +- docs/features/techdocs/concepts.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/contribute/project-structure.md b/docs/contribute/project-structure.md index f1be29c312..9753aa201d 100644 --- a/docs/contribute/project-structure.md +++ b/docs/contribute/project-structure.md @@ -165,7 +165,7 @@ are separated out into their own folder, see further down. - [`techdocs-node/`](https://github.com/backstage/backstage/tree/master/plugins/techdocs-node) - Common node.js functionalities for TechDocs, to be shared between [techdocs-backend](https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend) - plugin and [techdocs-cli](https://github.com/backstage/techdocs-cli). + plugin and [techdocs-cli](https://github.com/backstage/backstage/tree/master/packages/techdocs-cli). - [`test-utils/`](https://github.com/backstage/backstage/tree/master/packages/test-utils) - This package contains general purpose testing facilities for testing a diff --git a/docs/features/techdocs/architecture.md b/docs/features/techdocs/architecture.md index ff1c9d30eb..02daea54a7 100644 --- a/docs/features/techdocs/architecture.md +++ b/docs/features/techdocs/architecture.md @@ -31,7 +31,7 @@ The static files consist of HTML, CSS and Images generated by MkDocs. We remove all the JavaScript before adding them to Backstage for security reasons. And there is an additional `techdocs_metadata.json` file that TechDocs needs to render a site. It's important that you use either -[techdocs-cli](https://github.com/backstage/techdocs-cli) or +[techdocs-cli](https://github.com/backstage/backstage/tree/master/packages/techdocs-cli) or [techdocs-container](https://github.com/backstage/techdocs-container) to generate the docs for the expected output. diff --git a/docs/features/techdocs/concepts.md b/docs/features/techdocs/concepts.md index f427f0cd2b..a5d9651f67 100644 --- a/docs/features/techdocs/concepts.md +++ b/docs/features/techdocs/concepts.md @@ -87,7 +87,7 @@ documentation for publishing. Currently it mostly acts as a wrapper around the TechDocs container and provides an easy-to-use interface for our docker container. -[TechDocs CLI](https://github.com/backstage/techdocs-cli) +[TechDocs CLI](https://github.com/backstage/backstage/tree/master/packages/techdocs-cli) ## TechDocs Reader