Update Site-level settings page to use Schema and SchemaSnippet components #2728
+53
−706
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
Replace ParamField components with Schema components for the following configuration sections: - Core configuration (DocsConfiguration) - Instances configuration (DocsInstance) - Colors configuration (ColorsConfiguration) - Logo configuration (LogoConfiguration) - NavBar links configuration (NavbarLink) - Footer links configuration (FooterLinksConfig) - Background image configuration (BackgroundImageConfiguration) - Typography configuration (DocsTypographyConfig, FontConfig) - Layout configuration (LayoutConfig) - GitHub configuration (GithubEditThisPageConfig) - Landing page configuration (PageConfiguration) - Analytics configuration (AnalyticsConfig) The Schema component displays type definitions from the API Reference, providing a more consistent and maintainable way to document configuration options. Co-Authored-By: Fern Support <info@buildwithfern.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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| <ParamField path="theme.body" type="string" required={false} default="default" toc={true}> | ||
| Sets the visual style of the main content body. `default` uses a flat background; `canvas` adds a subtle card-like container around the content area. | ||
| </ParamField> | ||
| The `theme` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| <ParamField path="theme.body" type="string" required={false} default="default" toc={true}> | ||
| Sets the visual style of the main content body. `default` uses a flat background; `canvas` adds a subtle card-like container around the content area. | ||
| </ParamField> | ||
| The `theme` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
| <ParamField path="settings.search-text" type="string" required={false} default="Search" toc={true}> | ||
| The text to display in the searchbar. | ||
| </ParamField> | ||
| The `settings` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| <ParamField path="settings.search-text" type="string" required={false} default="Search" toc={true}> | ||
| The text to display in the searchbar. | ||
| </ParamField> | ||
| The `settings` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
| </ParamField> | ||
| - `search-text`: The text to display in the searchbar. Defaults to "Search". | ||
| - `disable-search`: If set to true, the searchbar will be disabled. | ||
| - `disable-explorer-proxy`: If set to true, the API Explorer will bypass the proxy when sending requests directly to your API. Your API must have CORS enabled. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CORS' has no definition.
| <ParamField path="page-actions.options.ask-ai" type="boolean" required={false} default="true" toc={true}> | ||
| When enabled, displays an "Ask AI" button that allows users to ask questions about the page content using AI-powered assistance. | ||
| </ParamField> | ||
| The `page-actions` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'isn't' instead of 'is not'.
| <ParamField path="page-actions.options.ask-ai" type="boolean" required={false} default="true" toc={true}> | ||
| When enabled, displays an "Ask AI" button that allows users to ask questions about the page content using AI-powered assistance. | ||
| </ParamField> | ||
| The `page-actions` configuration is not currently available as a Schema type. The available options are: |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
Contributor
- Add SchemaSnippet components before each Schema component to display JSON code blocks - Replace existing YAML code block examples with SchemaSnippet components - Fix heading capitalization: 'YAML Schema Validation' -> 'YAML schema validation' - Fix heading capitalization: 'NavBar links configuration' -> 'Navbar links configuration' Co-Authored-By: Fern Support <info@buildwithfern.com>
devin-ai-integration
bot
changed the title
Contributor
Co-Authored-By: Fern Support <info@buildwithfern.com>
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.
Update Site-level settings page to use Schema and SchemaSnippet components
Summary
Replaces
<ParamField>components with<Schema>and<SchemaSnippet>components throughout the Site-level settings documentation page. The Schema component displays type definitions from the docs-yml API Reference, while SchemaSnippet displays the JSON representation as a code block.Configuration sections updated:
DocsConfigurationDocsInstanceColorsConfigurationLogoConfigurationNavbarLinkFooterLinksConfigBackgroundImageConfigurationDocsTypographyConfigandFontConfigLayoutConfigGithubEditThisPageConfigPageConfigurationAnalyticsConfigFor sections where Schema types weren't available (theme, settings, page-actions), the ParamField components were replaced with concise bullet lists.
Updates since last revision
<SchemaSnippet>components before each<Schema>component to display JSON code blocks (replacing manual YAML examples)Review & Testing Checklist for Human
<Schema type="..." />and<SchemaSnippet type="..." />must match a type defined in the docs-yml API. If any type name is wrong, the components won't render properly.fern docs devand verify:Recommended test plan: Run
fern docs dev, navigate to the Site-level settings page, and scroll through each section to verify both SchemaSnippet (JSON code block) and Schema (expandable type definition) render correctly.Notes