feat: landing page in docs (#3999)

* landing page * hook up landing page
fern-api · Jul 6, 2024 · 990f7ac · 990f7ac
1 parent 6aee117
commit 990f7ac
Show file tree

Hide file tree

Showing 21 changed files with 234 additions and 209 deletions.
diff --git a/.pnp.cjs b/.pnp.cjs
diff --git a/....98.4-bf08716d8-668b36101b-79f9847bfd.zip → ....98.9-3b3a3fe5f-ec323dd942-95367a9b40.zip b/....98.4-bf08716d8-668b36101b-79f9847bfd.zip → ....98.9-3b3a3fe5f-ec323dd942-95367a9b40.zip
diff --git a/packages/cli/configuration/fern/definition/docs.yml b/packages/cli/configuration/fern/definition/docs.yml
@@ -14,6 +14,7 @@ types:
       # navigation
       tabs: optional<map<TabId, TabConfig>>
       versions: optional<list<VersionConfig>>
+      landing-page: optional<PageConfiguration>
       navigation:
         type: optional<NavigationConfig>
         docs: The navigation config is skipped when multiple versions are present.
@@ -163,6 +164,7 @@ types:
   VersionFileConfig:
     properties:
       tabs: optional<map<TabId, TabConfig>>
+      landing-page: optional<PageConfiguration>
       navigation: NavigationConfig
 
   NavigationConfig:
@@ -420,6 +422,10 @@ types:
   SectionConfiguration:
     properties:
       section: string
+      path:
+        type: optional<string>
+        docs: |
+          The relative path to the markdown file that will be displayed when the section is clicked.
       contents: list<NavigationItem>
       collapsed: optional<boolean>
       slug: optional<string>

diff --git a/packages/cli/configuration/package.json b/packages/cli/configuration/package.json
@@ -29,20 +29,22 @@
   },
   "dependencies": {
     "@fern-api/core-utils": "workspace:*",
-    "@fern-api/fdr-sdk": "0.98.4-bf08716d8",
+    "@fern-api/fdr-sdk": "0.98.9-3b3a3fe5f",
     "@fern-api/fs-utils": "workspace:*",
     "@fern-api/task-context": "workspace:*",
     "@fern-fern/fiddle-sdk": "0.0.584",
     "dockerode": "^4.0.2",
     "find-up": "^6.3.0",
     "js-yaml": "^4.1.0",
+    "lodash-es": "^4.17.21",
     "tinycolor2": "^1.6.0",
     "zod": "^3.22.3"
   },
   "devDependencies": {
     "@types/dockerode": "^3.3.9",
     "@types/jest": "^29.0.3",
     "@types/js-yaml": "^4.0.8",
+    "@types/lodash-es": "^4.17.12",
     "@types/node": "^18.7.18",
     "@types/tinycolor2": "^1.4.6",
     "depcheck": "^1.4.6",

diff --git a/packages/cli/configuration/src/docs-yml/ParsedDocsConfiguration.ts b/packages/cli/configuration/src/docs-yml/ParsedDocsConfiguration.ts
@@ -12,7 +12,7 @@ export interface ParsedDocsConfiguration {
     pages: Record<RelativeFilePath, string>;
 
     /* navigation */
-    // tabs?: Record<RelativeFilePath, TabConfig>;
+    landingPage: DocsNavigationItem.Page | undefined;
     navigation: DocsNavigationConfiguration;
     navbarLinks: DocsV1Write.NavbarLink[] | undefined;
     footerLinks: DocsV1Write.FooterLink[] | undefined;
@@ -131,7 +131,7 @@ export interface VersionedDocsNavigation {
 }
 
 export interface VersionInfo {
-    // tabs?: Record<RelativeFilePath, TabConfig>;
+    landingPage: DocsNavigationItem.Page | undefined;
     navigation: UntabbedDocsNavigation | TabbedDocsNavigation;
     version: string;
     availability: VersionAvailability | undefined;
@@ -200,6 +200,7 @@ export declare namespace DocsNavigationItem {
         slug: string | undefined;
         hidden: boolean | undefined;
         skipUrlSlug: boolean | undefined;
+        overviewAbsolutePath: AbsoluteFilePath | undefined;
     }
 
     export interface ApiSection {
@@ -210,7 +211,7 @@ export declare namespace DocsNavigationItem {
         audiences: Audiences;
         showErrors: boolean;
         snippetsConfiguration: SnippetsConfiguration | undefined;
-        summaryAbsolutePath: AbsoluteFilePath | undefined;
+        overviewAbsolutePath: AbsoluteFilePath | undefined;
         navigation: ParsedApiReferenceLayoutItem[];
         hidden: boolean | undefined;
         slug: string | undefined;
@@ -255,7 +256,7 @@ export declare namespace ParsedApiReferenceLayoutItem {
         type: "section";
         title: string; // title
         referencedSubpackages: string[]; // subpackage IDs
-        summaryAbsolutePath: AbsoluteFilePath | undefined;
+        overviewAbsolutePath: AbsoluteFilePath | undefined;
         contents: ParsedApiReferenceLayoutItem[];
         slug: string | undefined;
         hidden: boolean | undefined;
@@ -266,7 +267,7 @@ export declare namespace ParsedApiReferenceLayoutItem {
         type: "package";
         title: string | undefined; // defaults to subpackage title
         package: string; // subpackage ID
-        summaryAbsolutePath: AbsoluteFilePath | undefined;
+        overviewAbsolutePath: AbsoluteFilePath | undefined;
         contents: ParsedApiReferenceLayoutItem[];
         slug: string | undefined;
         hidden: boolean | undefined;