Add Schema component to docs.yml reference page #1750
+95
−507
Conversation
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
- 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]>
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
Contributor
Contributor
Contributor
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ## Settings configuration | ||
|
|
||
| ## Settings configuration | ||
| Configure functional behaviors and features of your documentation site, including search, code display preferences, and API explorer settings. |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Explorer' instead of 'API explorer'.
|
|
||
| The slug can also be overridden in the frontmatter of the landing page Markdown file. | ||
| </ParamField> | ||
| ## SEO metadata configuration |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'SEO metadata configuration' should use sentence-style capitalization.
Contributor
Contributor
Contributor
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.
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:
Review & Testing Checklist for Human
fern docs devand navigate to the docs.yml reference page to verify all 15 Schema components render correctly and display type information (not just blank spaces)<Schema type="..." />exactly match the type names infern/apis/docs-yml/definition/docs.yml. A mismatch will cause silent failuresTest Plan
fern docs devin the docs repositoryNotes
loader.getTypes()to fetch type definitions from all APIs in the projectloader.getTypes()returns all types from all APIsLink to Devin run: https://app.devin.ai/sessions/82957910bea64400b08607bd1ee34924
Requested by: Devin Logan ([email protected]) (@devalog)