@mintlify/scraping 4.0.1230 → 4.0.1231

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mintlify/scraping",
-  "version": "4.0.1230",
+  "version": "4.0.1231",
   "description": "Scrape documentation frameworks to Mintlify docs",
   "engines": {
     "node": ">=18.0.0"
@@ -87,5 +87,5 @@
       "optional": true
     }
   },
-  "gitHead": "e929a72c0d7dc12e955ca24554b1a3d6e6171bfa"
+  "gitHead": "a037bb67d89d82707d5a9be6c5fcb8422f5b934e"
 }

package/src/sdk/converters/sphinx.ts

@@ -36,10 +36,13 @@ export async function convertSphinx(sourcePath: string): Promise<SdkReference> {
   const docs = splitSphinxModules(await loadDocs(sourcePath));
   const slugs = new Set(docs.map((doc) => doc.slug));
   const anchors = collectAnchors(docs);
-  return {
-    pages: docs.map((doc) => renderPage(doc, slugs, anchors)),
-    groups: buildSphinxNavigation(docs),
-  };
+  const pages = docs.map((doc) => renderPage(doc, slugs, anchors));
+  const [first, ...rest] = buildSphinxNavigation(docs);
+  const [overview, ...others] = first?.pages ?? [];
+  if (first?.group === 'Getting Started' && typeof overview === 'string' && !others.length) {
+    return { pages, groups: rest, overview };
+  }
+  return { pages, groups: first ? [first, ...rest] : [] };
 }
 
 type SphinxAnchors = Map<string, Map<string, string>>;

package/src/sdk/converters/typedoc.ts

@@ -201,6 +201,7 @@ export async function convertTypedoc(sourcePath: string): Promise<SdkReference>
 
   const overviewPages: SdkPage[] = [];
   const overviewGroups: SdkNavGroup[] = [];
+  let projectOverview: string | undefined;
   const reservedSlugs = new Set(pages.map((page) => page.slug.toLowerCase()));
   const containers = [project, ...modules.filter((module) => module !== project)];
   const overviews: { node: TypedocNode; slug: string }[] = [];
@@ -234,13 +235,15 @@ export async function convertTypedoc(sourcePath: string): Promise<SdkReference>
       isProject ? undefined : project.name
     );
     overviewPages.push(overview);
-    overviewGroups.push({
-      group: isProject ? 'Overview' : `${container.name} Overview`,
-      pages: [slug],
-    });
+    if (isProject) projectOverview = slug;
+    else overviewGroups.push({ group: `${container.name} Overview`, pages: [slug] });
   }
 
-  return { pages: [...overviewPages, ...pages], groups: [...overviewGroups, ...groups] };
+  return {
+    pages: [...overviewPages, ...pages],
+    groups: [...overviewGroups, ...groups],
+    ...(projectOverview ? { overview: projectOverview } : {}),
+  };
 }
 
 function hasCustomLayout(container: TypedocNode): boolean {

package/src/sdk/types.ts

@@ -29,6 +29,7 @@ export type SdkNavGroup = {
 export type SdkReference = {
   pages: SdkPage[];
   groups: SdkNavGroup[];
+  overview?: string;
 };
 
 export type SdkConverter = (sourcePath: string) => Promise<SdkReference>;