create-app: add example techdocs page

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2026-03-20 08:57:54 +01:00
parent 66c56c192e
commit 016098080a
3 changed files with 11 additions and 0 deletions
@@ -12,6 +12,8 @@ apiVersion: backstage.io/v1alpha1
 kind: Component
 metadata:
  name: example-website
+  annotations:
+    backstage.io/techdocs-ref: dir:./example-docs
 spec:
  type: website
  lifecycle: experimental
@@ -0,0 +1,5 @@
+# Example TechDocs page
+
+This is an example TechDocs page!
+
+The source of this documentation for the `example-website` component is found in the `examples/example-docs` directory, which is referenced from `examples/entities.yaml`. Typically the `docs` directory would live alongside the `catalog-info.yaml` file of a component instead, but in this case it is separated out to avoid cluttering the examples directory.
@@ -0,0 +1,4 @@
+site_name: example-website
+docs_dir: docs
+plugins:
+  - techdocs-core