Include device README file in top level docs

harp-tech · Nov 10, 2023 · 2d500c8 · 2d500c8
1 parent f46d26f
commit 2d500c8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/docfx.json b/docfx.json
@@ -44,7 +44,8 @@
         "files": [
           "logo.svg",
           "favicon.ico",
-          "editor/index.html",
+          "src/device.*/Assets/*.png",
+          "src/device.*/Assets/*.jpg",
           "images/**",
           "workflows/**"
         ]

diff --git a/src/harp.schemaprocessor/Program.cs b/src/harp.schemaprocessor/Program.cs
@@ -11,7 +11,7 @@
 
 var builder = new StringBuilder();
 builder.AppendLine($@"---
-uid: Harp.{deviceModel.device}
+uid: Harp.{deviceModel.device}.Device
 ---
 
 <table>
@@ -81,11 +81,13 @@
 var output = builder.ToString();
 if (args.Length > 1)
 {
-    File.WriteAllText(Path.Combine(args[1], $"Harp_{deviceModel.device}.md"), output);
-    File.WriteAllText(Path.Combine(args[1], $"Harp_{deviceModel.device}_Device.md"), $@"---
-uid: Harp.{deviceModel.device}.Device
+    File.WriteAllText(Path.Combine(args[1], $"Harp_{deviceModel.device}_Device.md"), output);
+    File.WriteAllText(Path.Combine(args[1], $"Harp_{deviceModel.device}.md"), $@"---
+uid: Harp.{deviceModel.device}
 ---
 
-[!include[Device](./Harp_{deviceModel.device}.md)]");
+[!include[README](~/src/device.{deviceModel.device.ToLowerInvariant()}/README.md)]
+
+[!include[RegisterTables](./Harp_{deviceModel.device}_Device.md)]");
 }
 else Console.WriteLine(output);