Skip to content

Comments

docs: document include prop for Schema component#3732

Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
fern/document-schema-include-prop
Open

docs: document include prop for Schema component#3732
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
fern/document-schema-include-prop

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 21, 2026

Summary

Documents the new include prop on the <Schema> component, added in fern-api/fern-platform#7267. Changes are limited to schema.mdx:

  • Adds a Filtering fields subsection under Usage with code examples for include and exclude
  • Adds a <ParamField> entry for include (placed before the existing exclude entry)
  • Documents the interaction when both include and exclude are specified

Local testing

Verified the page renders correctly via fern docs dev on localhost:3000. The new "Filtering fields" subsection and include <ParamField> display as expected. All CI checks (vale, run, check-assignee) pass.

Local preview of Schema docs page

View original video (rec-912dec7b5e4d402f952e8634e400a341-edited.mp4)

Review & Testing Checklist for Human

  • Verify example field names: The code examples use model and provider as field names on AIChatConfig. These were not validated against the actual type definition — swap to real field names if they are incorrect.
  • Confirm include + exclude interaction: The docs state a field must be in the include list and not in the exclude list. Confirm this matches the actual implementation in fern-platform#7267.
  • Check rendered page on preview deployment: Navigate to the Schema component page and ensure the new subsection and <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 and include property reference render correctly with no layout issues.

Notes

Link to Devin run | Requested by: Fern Support

@devin-ai-integration
Copy link
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

@github-actions
Copy link
Contributor

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants