Skip to content

feat(docs): add feedback config object with hide-feedback and require-email#16015

Open
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1779296312-add-feedback-config
Open

feat(docs): add feedback config object with hide-feedback and require-email#16015
devin-ai-integration[bot] wants to merge 1 commit into
mainfrom
devin/1779296312-add-feedback-config

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Description

Refs fern-api/fern-platform#11244

Adds a new top-level feedback configuration object to docs.yml schema with two properties:

  • hide-feedback (bool, default false) — hides the feedback widget. If either this or layout.hide-feedback is true, feedback is hidden.
  • require-email (bool, default false) — makes the email field required in the feedback form with submit-then-validate UX.

This is the CLI-side counterpart to the fern-platform PR that added FeedbackConfig to the FDR SDK types and updated the feedback form UI.

Changes Made

  • Added FeedbackConfig type definition to fern/apis/docs-yml/definition/docs.yml
  • Added feedback: optional<FeedbackConfig> to DocsConfiguration in the Fern API definition
  • Added FeedbackConfig to the generated SDK types (API + serialization) since the generator cannot currently re-run
  • Added FeedbackConfig Zod schema to DocsYmlSchemas.ts
  • Added ParsedFeedbackConfig interface and feedback field to ParsedDocsConfiguration
  • Added convertFeedbackConfig() in parseDocsConfiguration.ts to parse raw config
  • Wired feedback through DocsDefinitionResolver to the FDR payload
  • Updated docs-yml.schema.json with the new docs.FeedbackConfig definition
  • Added CLI changelog entry

Testing

  • Biome lint/format checks pass on modified files
  • CI will validate full compilation and test suite

Link to Devin session: https://app.devin.ai/sessions/f125aa345be14831ba6b74d33833fbc1

…-email

Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
@devin-ai-integration devin-ai-integration Bot requested a review from amckinney as a code owner May 20, 2026 17:32
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

Copy link
Copy Markdown

@claude claude Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude Code Review

This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.

Tip: disable this comment in your organization's Code Review settings.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

0 participants