Update docs.yml page to site-level settings #1879
Merged
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
- Rename page from 'What is docs.yml?' to 'Site-level settings' - Update title to 'Customize your site using docs.yml' - Update subtitle to 'Set theming, redirects, and more' - Rename file from what-is-docs-yml.mdx to site-level-settings.mdx - Add redirects from old URL to new URL - Update all internal links across documentation Co-Authored-By: Kapil Gowru <[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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| --- | ||
|
|
||
| You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/what-is-docs-yml). | ||
| You can add `availability` to an endpoint, type, or property within your Fern Definition. You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings). |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
| The `x-fern-availability` extension is used to mark the availability of an endpoint within your OpenAPI definition. The availability information propagates into the generated Fern Docs website as visual tags. | ||
|
|
||
| You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/what-is-docs-yml). | ||
| You can configure the `availability` of sections in your API reference documentation in your [`docs.yml` file](/learn/docs/configuration/site-level-settings). |
Contributor
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
| ## Custom icons across your navigation | ||
| You can now use your own image files as icons throughout your `docs.yml` navigation config, including for [navbar link](/learn/docs/configuration/what-is-docs-yml#navbar-links-configuration), [section, page](/learn/docs/configuration/navigation#sidebar-icons), and [product](/learn/docs/configuration/products#add-your-product-configuration) icons. | ||
| You can now use your own image files as icons throughout your `docs.yml` navigation config, including for [navbar link](/learn/docs/configuration/site-level-settings#navbar-links-configuration), [section, page](/learn/docs/configuration/navigation#sidebar-icons), and [product](/learn/docs/configuration/products#add-your-product-configuration) icons. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'now' that become outdated
| <Accordion title="RBAC, versioning, and multi-product support"> | ||
|
|
||
| Stainless doesn't currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/what-is-docs-yml) capabilities for complex API portfolios. | ||
| Stainless doesn't currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/site-level-settings) capabilities for complex API portfolios. |
Contributor
There was a problem hiding this comment.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
Contributor
- Change 'API reference' to 'API Reference' in availability docs - Remove time-relative terms 'now' and 'currently' from changelog and comparison docs Co-Authored-By: Kapil Gowru <[email protected]>
Contributor
Contributor
devalog
approved these changes
Nov 10, 2025
devalog
deleted the
devin/1762725791-update-docs-yml-page-to-site-level-settings
branch
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 docs.yml page to site-level settings
Summary
This PR renames the "What is docs.yml?" documentation page to "Site-level settings" with updated title and subtitle as requested. The changes include:
what-is-docs-yml.mdx→site-level-settings.mdx/learn/docs/configuration/what-is-docs-ymland/learn/docs/customization/what-is-docs-yml) to new URL (/learn/docs/configuration/site-level-settings)Review & Testing Checklist for Human
/learn/docs/configuration/what-is-docs-ymland/learn/docs/customization/what-is-docs-yml) and confirm they redirect to the new URL#layout-configuration,#instances-configuration, etc.) to ensure they still work correctly/learn/docs/configuration/site-level-settingsand verify the title and subtitle display correctlyTest Plan
fern docs devlocally/learn/docs/configuration/site-level-settingsand verify the page loadsNotes
Link to Devin run: https://app.devin.ai/sessions/06fdd38e8a5a47e8957dbea37b3031cd
Requested by: Kapil Gowru ([email protected]) / @kgowru