feat(docs): add feedback config object with hide-feedback and require-email#16015
Open
devin-ai-integration[bot] wants to merge 1 commit into
Open
feat(docs): add feedback config object with hide-feedback and require-email#16015devin-ai-integration[bot] wants to merge 1 commit into
devin-ai-integration[bot] wants to merge 1 commit into
Conversation
…-email Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
There was a problem hiding this comment.
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 fern-api/fern-platform#11244
Adds a new top-level
feedbackconfiguration object todocs.ymlschema with two properties:hide-feedback(bool, default false) — hides the feedback widget. If either this orlayout.hide-feedbackis 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
FeedbackConfigto the FDR SDK types and updated the feedback form UI.Changes Made
FeedbackConfigtype definition tofern/apis/docs-yml/definition/docs.ymlfeedback: optional<FeedbackConfig>toDocsConfigurationin the Fern API definitionFeedbackConfigto the generated SDK types (API + serialization) since the generator cannot currently re-runFeedbackConfigZod schema toDocsYmlSchemas.tsParsedFeedbackConfiginterface andfeedbackfield toParsedDocsConfigurationconvertFeedbackConfig()inparseDocsConfiguration.tsto parse raw configfeedbackthroughDocsDefinitionResolverto the FDR payloaddocs-yml.schema.jsonwith the newdocs.FeedbackConfigdefinitionTesting
Link to Devin session: https://app.devin.ai/sessions/f125aa345be14831ba6b74d33833fbc1