paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 37 Packages Projects Releases Wiki Activity

docs(techdocs): update how-to-guide for non-root paths

Browse Source 
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 <asnelaimis@gmail.com>
This commit is contained in:
Laimis Juzeliūnas
2025-03-12 11:23:51 +02:00
parent 5da90254c5
commit 148a118bde
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/techdocs/how-to-guides.md
+3 -2
View File
@@ -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?