Nest config under mkdocs key.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>

plugins/techdocs-backend/config.d.ts

@@ -46,13 +46,18 @@ export interface Config {
       pullImage?: boolean;
 
       /**
-       * (Optional and not recommended) Configures the techdocs generator to
-       * attempt to ensure an index.md exists falling back to using <docs-dir>/README.md
-       * or README.md in case a default <docs-dir>/index.md is not provided.
-       * Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior
-       * will be broken in these scenarios.
+       * Override behavior specific to mkdocs.
        */
-      legacyCopyReadmeMdToIndexMd?: boolean;
+      mkdocs?: {
+        /**
+         * (Optional and not recommended) Configures the techdocs generator to
+         * attempt to ensure an index.md exists falling back to using <docs-dir>/README.md
+         * or README.md in case a default <docs-dir>/index.md is not provided.
+         * Note that https://www.mkdocs.org/user-guide/configuration/#edit_uri behavior
+         * will be broken in these scenarios.
+         */
+        legacyCopyReadmeMdToIndexMd?: boolean;
+      };
     };
 
     /**

plugins/techdocs-node/src/stages/generate/techdocs.test.ts

@@ -145,7 +145,7 @@ describe('readGeneratorConfig', () => {
           runIn: 'docker',
           dockerImage: 'my-org/techdocs',
           pullImage: false,
-          legacyCopyReadmeMdToIndexMd: true,
+          mkdocs: { legacyCopyReadmeMdToIndexMd: true },
         },
       },
     });

plugins/techdocs-node/src/stages/generate/techdocs.ts

@@ -222,7 +222,7 @@ export function readGeneratorConfig(
       'techdocs.generator.mkdocs.omitTechdocsCorePlugin',
     ),
     legacyCopyReadmeMdToIndexMd: config.getOptionalBoolean(
-      'techdocs.generator.legacyCopyReadmeMdToIndexMd',
+      'techdocs.generator.mkdocs.legacyCopyReadmeMdToIndexMd',
     ),
   };
 }