feat(docs): add right-text field to logo configuration #11075
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Refs: Slack request from Catherine
Adds a new
right-textfield to theLogoConfigurationschema that allows users to configure text displayed to the right of their logo image. This is similar to what Cohere uses (showing "Docs" next to their logo), but now configurable for all users.Changes Made
right-textoptional string field toLogoConfigurationin the docs-yml API definitionParsedDocsConfiguration.Logointerface to includerightTextconvertLogoReferencefunction to pass through the new fieldlogoRightTextinto the FDR write request inDocsDefinitionResolver.ts@ts-expect-errorcomment forlogoRightTextuntil FDR SDK is regeneratedCompanion PR: fern-api/fern-platform#5714 (adds
logoRightTextto FDR API definition and converters)Updates Since Last Revision
origin/mainto resolve merge conflicts@ts-expect-errorcomment inDocsDefinitionResolver.tsto suppress TypeScript error until FDR SDK is regenerated with the newlogoRightTextfieldHuman Review Checklist
hiddentoPlaygroundSettings- verify this addition is intentional or if it was picked up from another changelogoRightTextfield will be accepted by FDR (the fern-platform PR adds this to the FDR schema)right-text(kebab-case in YAML) mapping torightText(camelCase in TS) is correct@ts-expect-errorcomment should be removed once the FDR SDK is regeneratedTesting
pnpm run check)pnpm turbo run compile --filter=@fern-api/docs-resolver)Link to Devin run: https://app.devin.ai/sessions/42df904f84f64b34a0696ddc33533983
Requested by: Catherine Deskur ([email protected])