Skip to content

Document settings.disable-explorer-proxy in docs.yml #1699

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 2, 2025
Merged

Document settings.disable-explorer-proxy in docs.yml #1699

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cd4860
docs: add settings.disable-explorer-proxy documentation
devin-ai-integration[bot] Nov 1, 2025
8ef265b
fix: address Vale linting suggestions
devin-ai-integration[bot] Nov 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions fern/products/docs/pages/customization/what-is-docs-yml.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -536,6 +536,7 @@ layout:
settings:
search-text: "Search the docs..."
disable-search: false
disable-explorer-proxy: false
dark-mode-code: true
default-search-filters: true
http-snippets: false
Expand All @@ -551,6 +552,14 @@ settings:
If set to true, the searchbar will be disabled. Use this if you want to use a custom search solution.
</ParamField>

<ParamField path="settings.disable-explorer-proxy" type="boolean" required={false} default="false" toc={true}>
If set to true, the API explorer will bypass the proxy when sending requests directly to your API.
Copy link
Contributor

@github-actions github-actions bot Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[FernStyles.Reject] Use 'API Explorer' instead of 'API explorer'.


<Warning>
When this feature is enabled, your API must have CORS (Cross-Origin Resource Sharing) enabled to allow requests from the documentation domain.
Copy link
Contributor

@github-actions github-actions bot Nov 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'CORS' has no definition.

</Warning>
</ParamField>

<ParamField path="settings.dark-mode-code" type="boolean" required={false} default="false" toc={true}>
If set to true, the code blocks will be displayed in dark mode, regardless of the selected theme.
</ParamField>
Expand Down