Docs: more tweaks to the documentation

scripts/generateDocs.ts

@@ -130,6 +130,8 @@ class WikiPageGenerator {
 }
 
 export class GenerateDocs extends Script {
+    private generatedPaths: string[] = []
+
     constructor() {
         super("Generates various documentation files")
     }
@@ -192,7 +194,11 @@ export class GenerateDocs extends Script {
                 mkdirSync("./Docs/Themes")
             }
             this.generateOverviewsForAllSingleLayer()
-            this.generateNormalLayerOverview()
+            this.generateNormalLayerOverview("Layers")
+            this.generateNormalLayerOverview("Layers", "nl")
+            this.generateNormalLayerOverview("Themes")
+            this.generateNormalLayerOverview("Themes", "nl")
+
             if (!existsSync("./Docs/nl")) {
                 mkdirSync("./Docs/nl")
             }
@@ -212,10 +218,16 @@ export class GenerateDocs extends Script {
         ])
 
         new WikiPageGenerator().generate()
+        this.generatedPaths.push("wikiIndex.txt")
 
         this.generateSidebar() // Must be last as it inspects the generated markdown files
         this.generateSidebar("nl")
 
+        this.generatedPaths.push(".gitignore")
+        writeFileSync("./Docs/.gitignore", this.generatedPaths
+            .map(p => p.replace("./Docs/", ""))
+            .join("\n"), "utf-8")
+
         console.log("Generated docs")
     }
 
@@ -272,6 +284,7 @@ export class GenerateDocs extends Script {
 
 
         writeFileSync(filename, warnAutomated + md + (options?.noWarn ? "" : "\n\n" + generatedFrom + "\n"))
+        this.generatedPaths.push(filename)
     }
 
 
@@ -725,8 +738,9 @@ export class GenerateDocs extends Script {
 
     /**
      * Generates the '_sidebar.md' file that is used by docsify
+     * Returns _all_ the filepaths (including ''hidden'' ones)
      */
-    private generateSidebar(subdirectory = "") {
+    private generateSidebar(subdirectory = ""): string[] {
         const tr = Translations.t.app.back.textFor(subdirectory)
         const sidebar: string[] = [
             `<a href='https://mapcomplete.org' class='back-to-mc'>${tr}</a>`
@@ -734,8 +748,8 @@ export class GenerateDocs extends Script {
         const allFiles = ScriptUtils.readDirRecSync("./Docs/" + subdirectory)
             .filter(path => path.endsWith(".md"))
             .filter(path => !path.startsWith("_"))
+            .filter(path => !path.startsWith("./Docs/nl/") || path.startsWith("./Docs/" + subdirectory))
             .map(path => path.substring("./Docs/".length + subdirectory.length + 1))
-        console.log("AllFiles: " + subdirectory, allFiles)
         const perDirectory = new Map<string, string[]>()
 
         function addFile(dir: string, path: string) {
@@ -761,6 +775,9 @@ export class GenerateDocs extends Script {
             }
         }
 
+        perDirectory.delete("nl")
+
+
         // The directories to run over:
         const directories: [string, Translation | string][] = [
             ["", ""],
@@ -769,7 +786,6 @@ export class GenerateDocs extends Script {
             ["Layers", new Translation({ en: "Overview of layers", nl: "Overzicht van de lagen" })],
             ["Themes", new Translation({ en: "Overview of map themes", nl: "Overzicht van de themas" })],
             ["UserTests", "Usability tests with users"],
-            ["nl", null] // indicate skip
         ]
 
 
@@ -789,6 +805,9 @@ export class GenerateDocs extends Script {
                 }
                 sidebar.push(`\n\n [**${titleStr}**](${dir}/README.md)`)
             }
+            if (dir === "Layers" || dir == "Themes") {
+                continue
+            }
             for (const path of files) {
                 if (path.startsWith("_") || path.endsWith("README.md")) {
                     continue
@@ -806,17 +825,60 @@ export class GenerateDocs extends Script {
             noTableOfContents: true,
             noWarn: true,
         })
+        const scriptPath = `./Docs/${subdirectory}/_paths.js`
+        writeFileSync(scriptPath, "var docsify_paths = " + JSON.stringify(allFiles))
+        this.generatedPaths.push(scriptPath)
+
+        return allFiles
     }
 
-    private generateNormalLayerOverview() {
-        const doc = ["# Layers",
-            `The following layers are available in MapComplete ${Constants.vNumber}:`,
-            MarkdownUtils.list(
-                Array.from(AllSharedLayers.sharedLayers.keys()).map(
-                    (id) => `[${id}](./Layers/${id}.md)`,
-                ),
-            )]
-        this.writeMarkdownFile("./Docs/Layers/README.md", doc.join("\n\n"), ["./assets/layers/*.json"])
+    private generateNormalLayerOverview(type: "Layers" | "Themes", subdir = "") {
+
+        const layerinfo: [string, string, string][] = []
+        const source: {
+            get(id: string): { id: string, name?: Translation, title?: Translation, description?: Translation },
+            keys(): Iterable<string>
+        }
+            = type === "Layers" ? AllSharedLayers.sharedLayers : AllKnownLayouts.allKnownLayouts
+        const keys = Array.from(source.keys())
+        keys.sort()
+
+        for (const id of keys) {
+            const layer = source.get(id)
+            let name = layer.title
+            if (type === "Layers") {
+                const layer_ = (<LayerConfig><unknown>layer)
+                if (!layer_.isNormal()) {
+                    continue
+                }
+                name = layer.name
+            }
+            layerinfo.push([`[${id}](./Layers/${id})`, name.textFor(subdir), (layer["shortDescription"] ?? layer.description)?.textFor(subdir)])
+        }
+
+        const titles = {
+            "Layers": new Translation({ en: "Layers", nl: "Lagen" }),
+            "Themes": new Translation({ en: "Themes", nl: "Kaartthema's" })
+        }
+
+        const intro: Record<string, TypedTranslation<{ version }>> = {
+            "Layers": new TypedTranslation<{ version }>({
+                en: "The following layers are available in MapComplete {version}:",
+                nl: "De volgende lagen zijn beschikbaar in MapComplete {version}:"
+            }),
+            "Themes": new TypedTranslation<{ version }>({
+                en: "The following themes are available in MapComplete {version}:",
+                nl: "De volgende kaartthemas zijn beschikbaar in MapComplete {version}:"
+            })
+        }
+
+        const doc = ["# " + titles[type].textFor(subdir),
+            intro[type].Subs({ version: Constants.vNumber }).textFor(subdir)
+            , MarkdownUtils.table(
+                ["id", "name", "description"],
+                layerinfo)
+        ]
+        this.writeMarkdownFile(`./Docs/${subdir}/${type}/README.md`, doc.join("\n\n"), [`./assets/${type.toLowerCase()}/*.json`])
     }
 
     /**