fix(cli): Set instance when migrating Mintlify > Fern

packages/cli/docs-importers/commons/src/FernDocsBuilder.ts

@@ -55,6 +55,8 @@ export abstract class FernDocsBuilder {
     public abstract setLayout({ layout }: { layout: docsYml.RawSchemas.LayoutConfig }): void;
 
     public abstract build({ outputDirectory }: { outputDirectory: AbsoluteFilePath }): void;
+
+    public abstract setInstance({ companyName }: { companyName: string }): string;
 }
 
 export abstract class FernDocsNavigationBuilder {

packages/cli/docs-importers/commons/src/FernDocsBuilderImpl.ts

@@ -151,6 +151,21 @@ export class FernDocsBuilderImpl extends FernDocsBuilder {
             })
         );
     }
+
+    public setInstance({ companyName }: { companyName: string }): string {
+        // We may append a suffix to the company name string to make it harder for
+        // other companies to build migrators for our docs. For now, we're not doing
+        // so but we can add that easily in the future.
+        const formattedCompanyString = companyName.toLowerCase().replace(" ", "-");
+
+        const fernDocsUrl = `https://${formattedCompanyString}.docs.buildwithfern.com`;
+
+        this.docsYml.instances.push({
+            url: fernDocsUrl
+        });
+
+        return fernDocsUrl;
+    }
 }
 
 export class TabbedNavigationBuilderImpl implements FernDocsNavigationBuilder {

packages/cli/docs-importers/mintlify/src/MintlifyImporter.ts

@@ -95,6 +95,13 @@ export class MintlifyImporter extends DocsImporter<MintlifyImporter.Args> {
             }
         }
         this.context.logger.debug("Imported OpenAPI specs");
+
+        // We're currently setting one instance so that clients can generate docs out of the box,
+        // but they'll have the option to add additional instances and custom domains later.
+        const instanceUrl = builder.setInstance({
+            companyName: mint.name
+        });
+        this.context.logger.debug(`Added instance ${instanceUrl} to docs.yml`);
     }
 
     private async getNavigationBuilder({

packages/cli/docs-importers/mintlify/src/__test__/outputs/bland/fern/docs.yml

@@ -1,4 +1,5 @@
-instances: []
+instances:
+  - url: https://bland-ai.docs.buildwithfern.com 
 title: Bland AI
 favicon: logo.png
 logo:

packages/cli/docs-importers/mintlify/src/__test__/outputs/layerfi/fern/docs.yml

@@ -1,4 +1,5 @@
-instances: []
+instances:
+  - url: https://layer.docs.buildwithfern.com
 title: Layer
 favicon: favicon.png
 logo:

packages/cli/docs-importers/mintlify/src/__test__/outputs/zep/fern/docs.yml

@@ -1,4 +1,5 @@
-instances: []
+instances:
+  - url: https://zep-documentation.docs.buildwithfern.com
 title: Zep Documentation
 favicon: logo/favicon.png
 logo: