feat: landing page + overview page for sections (#1113)

fern-api · Jul 6, 2024 · 3b3a3fe · 3b3a3fe
1 parent cec2247
commit 3b3a3fe
Show file tree

Hide file tree

Showing 60 changed files with 4,988 additions and 4,787 deletions.
diff --git a/fern/apis/fdr/definition/docs/v1/db/__package__.yml b/fern/apis/fdr/definition/docs/v1/db/__package__.yml
@@ -121,6 +121,7 @@ types:
     properties:
       tabs: optional<list<NavigationTab>>
       tabsV2: optional<list<NavigationTabV2>>
+      landingPage: optional<docsReadV1.PageMetadata>
 
   NavigationTab:
     availability: deprecated
@@ -147,6 +148,7 @@ types:
   UnversionedUntabbedNavigationConfig:
     properties:
       items: list<NavigationItem>
+      landingPage: optional<docsReadV1.PageMetadata>
 
   VersionedNavigationConfig:
     properties:
@@ -196,3 +198,4 @@ types:
       collapsed: boolean
       hidden: optional<boolean>
       fullSlug: optional<list<string>>
+      overviewPageId: optional<commons.PageId>
diff --git a/fern/apis/fdr/definition/docs/v1/read/__package__.yml b/fern/apis/fdr/definition/docs/v1/read/__package__.yml
@@ -169,6 +169,7 @@ types:
   UnversionedTabbedNavigationConfig:
     properties:
       tabs: list<NavigationTab>
+      landingPage: optional<PageMetadata>
 
   NavigationTab:
     union:
@@ -193,6 +194,7 @@ types:
   UnversionedUntabbedNavigationConfig:
     properties:
       items: list<NavigationItem>
+      landingPage: optional<PageMetadata>
 
   VersionedNavigationConfig:
     properties:
@@ -345,6 +347,7 @@ types:
       items: list<NavigationItem>
       skipUrlSlug: boolean
       collapsed: boolean
+      overviewPageId: optional<commons.PageId>
 
   ApiArtifacts:
     properties:

diff --git a/fern/apis/fdr/definition/docs/v1/write/__package__.yml b/fern/apis/fdr/definition/docs/v1/write/__package__.yml
@@ -162,6 +162,7 @@ types:
         type: optional<list<NavigationTab>>
         availability: deprecated
       tabsV2: optional<list<NavigationTabV2>>
+      landingPage: optional<PageMetadata>
 
   NavigationTab:
     availability: deprecated
@@ -193,6 +194,7 @@ types:
   UnversionedUntabbedNavigationConfig:
     properties:
       items: list<NavigationItem>
+      landingPage: optional<PageMetadata>
 
   VersionedNavigationConfig:
     properties:
@@ -382,7 +384,7 @@ types:
           This is only applicable to sections that are at the root level in the sidebar.
           If false, the section title will be displayed as a header and the items will be displayed below it, and cannot be collapsed.
       skipUrlSlug: optional<boolean>
-      summaryPageId:
+      overviewPageId:
         type: optional<commons.PageId>
         availability: in-development
         docs: |

diff --git a/fern/apis/navigation/definition/__package__.yml b/fern/apis/navigation/definition/__package__.yml
@@ -20,8 +20,7 @@ types:
     discriminated: false
     union:
       - VersionedNode
-      - TabbedNode
-      - SidebarRootNode
+      - UnversionedNode
 
   VersionChild:
     discriminated: false
@@ -71,6 +70,13 @@ types:
       type: literal<"versioned">
       children: list<VersionNode>
 
+  UnversionedNode:
+    extends: WithNodeId
+    properties:
+      type: literal<"unversioned">
+      child: VersionChild
+      landingPage: optional<LandingPageNode>
+
   TabbedNode:
     extends: WithNodeId
     properties:
@@ -125,6 +131,7 @@ types:
       versionId: VersionId
       child: VersionChild
       availability: optional<Availability>
+      landingPage: optional<LandingPageNode>
 
   TabNode:
     extends:
@@ -140,6 +147,12 @@ types:
       type: literal<"page">
       pageId: PageId
 
+  LandingPageNode:
+    extends: WithNodeMetadata
+    properties:
+      type: literal<"landingPage">
+      pageId: PageId
+
   SectionNode:
     extends:
       - WithNodeMetadata

diff --git a/...dk/src/client/generated/api/resources/docs/resources/v1/resources/db/types/DocsSection.ts b/...dk/src/client/generated/api/resources/docs/resources/v1/resources/db/types/DocsSection.ts
diff --git a/...d/api/resources/docs/resources/v1/resources/db/types/UnversionedTabbedNavigationConfig.ts b/...d/api/resources/docs/resources/v1/resources/db/types/UnversionedTabbedNavigationConfig.ts
diff --git a/...api/resources/docs/resources/v1/resources/db/types/UnversionedUntabbedNavigationConfig.ts b/...api/resources/docs/resources/v1/resources/db/types/UnversionedUntabbedNavigationConfig.ts
diff --git a/.../src/client/generated/api/resources/docs/resources/v1/resources/read/types/DocsSection.ts b/.../src/client/generated/api/resources/docs/resources/v1/resources/read/types/DocsSection.ts
diff --git a/...api/resources/docs/resources/v1/resources/read/types/UnversionedTabbedNavigationConfig.ts b/...api/resources/docs/resources/v1/resources/read/types/UnversionedTabbedNavigationConfig.ts
diff --git a/...i/resources/docs/resources/v1/resources/read/types/UnversionedUntabbedNavigationConfig.ts b/...i/resources/docs/resources/v1/resources/read/types/UnversionedUntabbedNavigationConfig.ts
diff --git a/...src/client/generated/api/resources/docs/resources/v1/resources/write/types/DocsSection.ts b/...src/client/generated/api/resources/docs/resources/v1/resources/write/types/DocsSection.ts
diff --git a/...pi/resources/docs/resources/v1/resources/write/types/UnversionedTabbedNavigationConfig.ts b/...pi/resources/docs/resources/v1/resources/write/types/UnversionedTabbedNavigationConfig.ts
diff --git a/.../resources/docs/resources/v1/resources/write/types/UnversionedUntabbedNavigationConfig.ts b/.../resources/docs/resources/v1/resources/write/types/UnversionedUntabbedNavigationConfig.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/LandingPageNode.ts b/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/LandingPageNode.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/RootChild.ts b/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/RootChild.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/UnversionedNode.ts b/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/UnversionedNode.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/VersionNode.ts b/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/VersionNode.ts
diff --git a/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/index.ts b/packages/fdr-sdk/src/client/generated/api/resources/navigation/types/index.ts
diff --git a/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts
@@ -145,12 +145,14 @@ function transformUnversionedNavigationConfigForDb(
         untabbed: (config) => {
             return {
                 items: config.items.map(transformNavigationItemForDb),
+                landingPage: transformPageNavigationItemForDb(config.landingPage),
             };
         },
         tabbed: (config) => {
             return {
                 tabs: config.tabs?.map(transformNavigationTabForDb),
                 tabsV2: config.tabsV2?.map(transformNavigationTabV2ForDb),
+                landingPage: transformPageNavigationItemForDb(config.landingPage),
             };
         },
     });
@@ -250,6 +252,7 @@ export function transformNavigationItemForDb(
                 items: writeShape.items.map((item) => transformNavigationItemForDb(item)),
                 skipUrlSlug: writeShape.skipUrlSlug ?? false,
                 fullSlug: writeShape.fullSlug,
+                overviewPageId: writeShape.overviewPageId,
             };
         case "link":
             return {

diff --git a/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts b/packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts
@@ -126,11 +126,13 @@ function transformUnversionedNavigationConfigForDb(
                     config.tabsV2?.map(transformNavigationTabV2ForDb) ??
                     config.tabs?.map(transformNavigationTabForDb) ??
                     [],
+                landingPage: config.landingPage,
             };
         },
         untabbed: (config) => {
             return {
                 items: config.items.map(transformNavigationItemForDb),
+                landingPage: config.landingPage,
             };
         },
     });

diff --git a/packages/fdr-sdk/src/navigation/__test__/__snapshots__/primer.test.ts.snap b/packages/fdr-sdk/src/navigation/__test__/__snapshots__/primer.test.ts.snap
@@ -1082,6 +1082,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/introdu
     "hidden": false,
     "icon": undefined,
     "id": "root..v2.2",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2.2/introduction/getting-started",
     "slug": "docs/api/v2.2",
     "title": "v2.2",
@@ -1494,6 +1495,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/introdu
     "hidden": false,
     "icon": undefined,
     "id": "root..v2.1",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2.1/introduction/getting-started",
     "slug": "docs/api/v2.1",
     "title": "v2.1",
@@ -1795,6 +1797,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/introdu
     "hidden": false,
     "icon": undefined,
     "id": "root..v2",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2/introduction/getting-started",
     "slug": "docs/api/v2",
     "title": "v2",
@@ -2747,6 +2750,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/v2.1/ap
     "hidden": false,
     "icon": undefined,
     "id": "root..v2.2",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2.2/introduction/getting-started",
     "slug": "docs/api/v2.2",
     "title": "v2.2",
@@ -3159,6 +3163,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/v2.1/ap
     "hidden": false,
     "icon": undefined,
     "id": "root..v2.1",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2.1/introduction/getting-started",
     "slug": "docs/api/v2.1",
     "title": "v2.1",
@@ -3460,6 +3465,7 @@ exports[`getNavigationRoot > primer > gets navigation root for /docs/api/v2.1/ap
     "hidden": false,
     "icon": undefined,
     "id": "root..v2",
+    "landingPage": undefined,
     "pointsTo": "docs/api/v2/introduction/getting-started",
     "slug": "docs/api/v2",
     "title": "v2",