Added Tech Docs to Backstage-Demo

roadie-demo · Nov 30, 2023 · 707194c · 707194c
1 parent eebbdf5
commit 707194c
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/catalog-info.yaml b/catalog-info.yaml
@@ -5,6 +5,7 @@ metadata:
   description: An example deployment of a Backstage application.
   annotations:
     github.com/project-slug: roadie-demo/backstage-demo
+    backstage.io/techdocs-ref: dir:.
 spec:
   type: website
   owner: backstage/maintainers

diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1,3 @@
+# Backstage Demo Tech Docs
+
+For more information regarding Tech Docs, please see [Roadie Docs > Using Tech Docs](https://roadie.io/docs/getting-started/technical-documentation/).
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,8 @@
+site_name: 'backstage-demo'
+
+plugins:
+  - techdocs-core
+
+# Uncomment to add extensions if desired
+#markdown_extensions:
+#  - markdown_inline_mermaid