From 148a118bde0eb1bd53501c142bb569e16b1435cc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Laimis=20Juzeli=C5=ABnas?= Date: Wed, 12 Mar 2025 11:23:51 +0200 Subject: [PATCH] docs(techdocs): update how-to-guide for non-root paths MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This commit/change updates the Techdocs how-to-guide to include an explanation about mandatory suffix for non-root paths. Signed-off-by: Laimis Juzeliūnas --- docs/features/techdocs/how-to-guides.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/features/techdocs/how-to-guides.md b/docs/features/techdocs/how-to-guides.md index 5a9044842f..9444dc9b6e 100644 --- a/docs/features/techdocs/how-to-guides.md +++ b/docs/features/techdocs/how-to-guides.md @@ -92,10 +92,11 @@ the source code hosting provider. Notice that instead of the `dir:` prefix, the Note, just as it's possible to specify a subdirectory with the `dir:` prefix, you can also provide a path to a non-root directory inside the repository which -contains the `mkdocs.yml` file and `docs/` directory. +contains the `mkdocs.yml` file and `docs/` directory. It is important that it is +suffixed with a '/' in order for relative path resolution to work consistently. e.g. -`url:https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/examples/documented-component` +`url:https://github.com/backstage/backstage/tree/master/plugins/techdocs-backend/examples/documented-component/` ### Why is URL Reader faster than a git clone?