Skip to content

docs: unhide GraphQL API Reference page and add to overview #5606

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
devalog merged 4 commits into from
May 22, 2026
Merged

docs: unhide GraphQL API Reference page and add to overview #5606

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ad5b046
docs: unhide GraphQL API Reference page and add to overview
devin-ai-integration[bot] May 22, 2026
3cf38fe
docs: add link to GraphQL example project
devin-ai-integration[bot] May 22, 2026
97308be
docs: link to live GraphQL example site and GitHub source
devin-ai-integration[bot] May 22, 2026
9035553
docs: update example callout wording and use Tip
devin-ai-integration[bot] May 22, 2026
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
1 change: 0 additions & 1 deletion fern/products/docs/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -316,7 +316,6 @@ navigation:
- page: GraphQL Reference
path: ./pages/api-references/generate-graphql-ref.mdx
slug: generate-graphql-ref
hidden: true
- page: Library Reference
path: ./pages/api-references/library-docs.mdx
slug: library-reference
Expand Down
7 changes: 4 additions & 3 deletions fern/products/docs/pages/api-references/generate-graphql-ref.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
---
title: Generate GraphQL Reference
description: Use Fern Docs to generate GraphQL API Reference documentation from a GraphQL schema.
availability: pre-release
---

<Warning>GraphQL API Reference is not actively maintained. [Contact us](https://buildwithfern.com/book-demo) if you have questions.</Warning>

Fern generates API Reference documentation from a [GraphQL schema](https://graphql.org/learn/schema/). Add your schema file to your Fern project and Fern renders queries, mutations, subscriptions, and types as an interactive reference.

<Tip>
See a [live example](https://graphql.docs.buildwithfern.com) or browse the [source on GitHub](https://github.com/fern-api/docs-examples/tree/main/graphql).
</Tip>

## Configuration

<Steps>
Expand Down
3 changes: 3 additions & 0 deletions fern/products/docs/pages/api-references/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Fern generates interactive API Reference documentation from an [OpenAPI specific
<Card title="OpenRPC" icon="fa-duotone fa-brackets-curly" href="/learn/docs/api-references/generate-openrpc-ref">
OpenRPC specification
</Card>
<Card title="GraphQL" icon="fa-duotone fa-diagram-project" href="/learn/docs/api-references/generate-graphql-ref">
GraphQL schema
</Card>
<Card title="Library" icon="fa-duotone fa-book" href="/learn/docs/api-references/library-reference">
Python or C++ source code
</Card>
Expand Down
7 changes: 4 additions & 3 deletions fern/translations/zh/products/docs/pages/api-references/generate-graphql-ref.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@
title: 生成 GraphQL 参考文档
description: 使用 Fern Docs 从 GraphQL schema 生成 GraphQL API 参考文档。
sidebar-title: 生成 GraphQL 参考
availability: pre-release
---

<Warning>GraphQL API 参考文档没有积极维护。如果您有疑问，[请联系我们](https://buildwithfern.com/book-demo)。</Warning>

Fern 从 [GraphQL schema](https://graphql.org/learn/schema/) 生成 API 参考文档。将您的 schema 文件添加到 Fern 项目中，Fern 会将查询、变更、订阅和类型渲染为交互式参考文档。

<Tip>
查看[在线示例](https://graphql.docs.buildwithfern.com)或浏览 [GitHub 源代码](https://github.com/fern-api/docs-examples/tree/main/graphql)。
</Tip>

## 配置

<Steps>
Expand Down
3 changes: 3 additions & 0 deletions fern/translations/zh/products/docs/pages/api-references/overview.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ Fern 从 [OpenAPI 规范](/learn/api-definitions/openapi/overview) 或其他 API
<Card title="OpenRPC" icon="fa-duotone fa-brackets-curly" href="/learn/docs/api-references/generate-openrpc-ref">
OpenRPC 规范
</Card>
<Card title="GraphQL" icon="fa-duotone fa-diagram-project" href="/learn/docs/api-references/generate-graphql-ref">
GraphQL schema
</Card>
<Card title="库" icon="fa-duotone fa-book" href="/learn/docs/api-references/library-reference">
Python 或 C++ 源代码
</Card>
Expand Down
Loading