feat(docs): add configurable logo right-text support

fern/apis/fdr/definition/docs/v1/db/__package__.yml

@@ -65,6 +65,7 @@ types:
       # logo
       logoHeight: optional<docsReadV1.Height>
       logoHref: optional<rootCommons.Url>
+      logoRightText: optional<string>
       favicon: optional<rootCommons.FileId>
 
       # seo

fern/apis/fdr/definition/docs/v1/read/__package__.yml

@@ -104,6 +104,7 @@ types:
       # logo
       logoHeight: optional<Height>
       logoHref: optional<rootCommons.Url>
+      logoRightText: optional<string>
       favicon: optional<rootCommons.FileId>
 
       # seo

fern/apis/fdr/definition/docs/v1/write/__package__.yml

@@ -103,6 +103,7 @@ types:
       # logo
       logoHeight: optional<Height>
       logoHref: optional<rootCommons.Url>
+      logoRightText: optional<string>
       favicon: optional<rootCommons.FileId>
 
       # seo

packages/commons/docs-server/src/withLogo.ts

@@ -36,7 +36,8 @@ export function withLogo(
         height: height ?? DEFAULT_LOGO_HEIGHT,
         href,
         light: resolveFileSrc(frontmatterLogo.light ?? lightDocsYmlLogo),
-        dark: resolveFileSrc(frontmatterLogo.dark ?? darkDocsYmlLogo)
+        dark: resolveFileSrc(frontmatterLogo.dark ?? darkDocsYmlLogo),
+        rightText: config.logoRightText
     };
 }
 

packages/commons/docs-utils/src/types/logo-configuration.ts

@@ -5,4 +5,5 @@ export interface LogoConfiguration {
     href: string | undefined;
     light: FileData | undefined;
     dark: FileData | undefined;
+    rightText: string | undefined;
 }

packages/commons/fdr-utils/src/definition-object-factory.ts

@@ -31,6 +31,7 @@ export class DefinitionObjectFactory {
                 footerLinks: undefined,
                 logoHeight: undefined,
                 logoHref: undefined,
+                logoRightText: undefined,
                 favicon: undefined,
                 metadata: undefined,
                 redirects: undefined,

packages/fdr-sdk/src/converters/db/convertDocsDefinitionToDb.ts

@@ -92,6 +92,7 @@ export function convertDocsDefinitionToDb({
             logoV2,
             logoHeight: writeShape.config.logoHeight,
             logoHref: writeShape.config.logoHref,
+            logoRightText: writeShape.config.logoRightText,
             colors,
             colorsV2,
             colorsV3:

packages/fdr-sdk/src/converters/read/convertDbDocsConfigToRead.ts

@@ -17,6 +17,7 @@ export function convertDbDocsConfigToRead({ dbShape }: { dbShape: DocsV1Db.DocsD
         root: dbShape.root,
         logoHeight: dbShape.logoHeight,
         logoHref: dbShape.logoHref,
+        logoRightText: dbShape.logoRightText,
         colorsV3: dbShape.colorsV3 ?? getColorsV3(dbShape),
         navbarLinks: dbShape.navbarLinks,
         footerLinks: dbShape.footerLinks,

packages/fern-docs/bundle/src/app/[host]/[domain]/layout.tsx

@@ -127,8 +127,7 @@ export default async function Layout({
                         />
                     </>
                 )}
-                {/** HACKHACK: this is a hack to set the logo text to "Docs" for Cohere, this needs to be moved into docs.yml */}
-                <SetLogoText text={domain.includes("cohere") ? "Docs" : undefined} />
+                <SetLogoText text={domain.includes("cohere") ? "Docs" : config.logoRightText} />
                 {config.defaultLanguage != null && <DefaultLanguage language={config.defaultLanguage} />}
                 <DarkCode value={(edgeFlags.isDarkCodeEnabled || settings.darkModeCode) ?? false} />
                 <Whitelabeled value={edgeFlags.isWhitelabeled} />

packages/fern-docs/bundle/src/server/withLogo.ts

@@ -19,9 +19,11 @@ export function withLogo(
     href: string;
     light: FileData | undefined;
     dark: FileData | undefined;
+    rightText: string | undefined;
 } {
     const height = config.logoHeight;
     const href = config.logoHref ?? encodeURI(slugToHref(basepath ?? ""));
+    const rightText = config.logoRightText;
 
     const frontmatterLogo = getLogoFromFrontmatter(frontmatter);
 
@@ -31,7 +33,8 @@ export function withLogo(
             height: height ?? DEFAULT_LOGO_HEIGHT,
             href,
             light: resolveFileSrc(frontmatterLogo.light),
-            dark: resolveFileSrc(frontmatterLogo.dark)
+            dark: resolveFileSrc(frontmatterLogo.dark),
+            rightText
         };
     }
 
@@ -41,7 +44,8 @@ export function withLogo(
             height: height ?? DEFAULT_LOGO_HEIGHT,
             href,
             light: preResolvedLogos.light,
-            dark: preResolvedLogos.dark
+            dark: preResolvedLogos.dark,
+            rightText
         };
     }
 
@@ -63,7 +67,8 @@ export function withLogo(
         height: height ?? DEFAULT_LOGO_HEIGHT,
         href,
         light: resolveFileSrc(lightDocsYmlLogo),
-        dark: resolveFileSrc(darkDocsYmlLogo)
+        dark: resolveFileSrc(darkDocsYmlLogo),
+        rightText
     };
 }
 

servers/fdr/src/healthchecks/checkRedis.ts

@@ -31,6 +31,7 @@ const HEALTHCHECK_DOCS_RESPONSE: CachedDocsResponse = {
                 hideNavLinks: undefined,
                 logoHeight: undefined,
                 logoHref: undefined,
+                logoRightText: undefined,
                 favicon: undefined,
                 metadata: undefined,
                 redirects: undefined,