Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Add Schema component to docs.yml reference page

Summary

Added the new <Schema type="TypeName" /> component (from PR #4442) to the docs.yml reference page to display type definitions visually for 15 major configuration types. The Schema components are placed immediately after the YAML code examples in each section to show the complete type structure from the docs-yml API definition.

Configuration types with Schema components:

  • DocsInstance
  • ColorsConfiguration
  • LogoConfiguration
  • RedirectConfig
  • NavbarLink
  • FooterLinksConfig
  • BackgroundImageConfiguration
  • DocsTypographyConfig
  • FontConfig
  • LayoutConfig
  • GithubEditThisPageConfig
  • PageConfiguration
  • MetadataConfig
  • AnalyticsConfig
  • ExperimentalConfig

Review & Testing Checklist for Human

⚠️ Critical - This PR is untested and may not work correctly:

  • Test locally: Run fern docs dev and navigate to the docs.yml reference page to verify all 15 Schema components render correctly and display type information (not just blank spaces)
  • Verify type names: Check that all type names used in <Schema type="..." /> exactly match the type names in fern/apis/docs-yml/definition/docs.yml. A mismatch will cause silent failures
  • Check visual presentation: Verify the Schema components are placed appropriately and don't disrupt the page layout or reading flow
  • Test Schema component functionality: Click through the type definitions to ensure they're interactive and show all nested properties correctly
  • Review coverage: Determine if additional configuration types should have Schema components added

Test Plan

  1. Run the docs locally: fern docs dev in the docs repository
  2. Navigate to /learn/docs/configuration/what-is-docs-yml
  3. Scroll through the page and verify each Schema component displays the type structure
  4. Check console for any errors about missing types
  5. Verify the Schema components enhance documentation rather than create confusion

Notes

  • The Schema component relies on the rehype-schema plugin which uses loader.getTypes() to fetch type definitions from all APIs in the project
  • I did not add the docs-yml API to the navigation tree - the Schema component should still work as long as loader.getTypes() returns all types from all APIs
  • If Schema components don't render, check that the docs-yml API types are accessible to the rehype-schema plugin
  • The Schema component silently returns null if a type isn't found, logging only to console

Link to Devin run: https://app.devin.ai/sessions/82957910bea64400b08607bd1ee34924
Requested by: Devin Logan ([email protected]) (@devalog)

- Add Schema component for 15 major configuration types
- Display type definitions visually using the new Schema component from PR #4442
- Includes Schema components for: DocsInstance, ColorsConfiguration, LogoConfiguration, RedirectConfig, NavbarLink, FooterLinksConfig, BackgroundImageConfiguration, DocsTypographyConfig, FontConfig, LayoutConfig, GithubEditThisPageConfig, PageConfiguration, AnalyticsConfig, MetadataConfig, and ExperimentalConfig

Co-Authored-By: Devin Logan <[email protected]>
@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

github-actions bot commented Nov 4, 2025

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.

1 participant