docs: document include prop for Schema component#3732
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
docs: document include prop for Schema component#3732devin-ai-integration[bot] wants to merge 1 commit intomainfrom
include prop for Schema component#3732devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Conversation
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:
|
Contributor
|
🌿 Preview your docs: https://fern-preview-c34980a7-e5e4-47c5-a073-b4f17262dc41.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
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.
Summary
Documents the new
includeprop on the<Schema>component, added in fern-api/fern-platform#7267. Changes are limited toschema.mdx:includeandexclude<ParamField>entry forinclude(placed before the existingexcludeentry)includeandexcludeare specifiedLocal testing
Verified the page renders correctly via
fern docs devon localhost:3000. The new "Filtering fields" subsection andinclude<ParamField>display as expected. All CI checks (vale, run, check-assignee) pass.View original video (rec-912dec7b5e4d402f952e8634e400a341-edited.mp4)
Review & Testing Checklist for Human
modelandprovideras field names onAIChatConfig. These were not validated against the actual type definition — swap to real field names if they are incorrect.include+excludeinteraction: The docs state a field must be in theincludelist and not in theexcludelist. Confirm this matches the actual implementation in fern-platform#7267.<ParamField>display correctly.Suggested test plan: Open the deployed preview, navigate to the Schema component page (
/learn/docs/writing-content/components/schema), and confirm the "Filtering fields" section andincludeproperty reference render correctly with no layout issues.Notes
Link to Devin run | Requested by: Fern Support