⚠ This page is served via a proxy. Original site: https://github.com
This service does not collect credentials or authentication data.
Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 9, 2026

Restructure API Reference documentation

Summary

Consolidates and reorganizes the API Reference documentation section:

  1. Moved configuration options from generate-api-ref.mdx into customize-api-ref.mdx as a "Configuration options" section using ParamField components with Badge tags indicating supported reference types (OpenAPI, Fern Definition, GraphQL, OpenRPC, Webhook, WebSocket, AsyncAPI). The old markdown table was removed and replaced with a link to the customize page.

  2. Merged endpoint errors page into customize-api-ref.mdx as a "Displaying endpoint errors" subsection. Deleted the standalone endpoint-errors.mdx and removed it from navigation.

  3. Merged server URLs page into api-explorer.mdx under the existing "Multiple environments" section. Deleted the standalone server-urls.mdx and removed it from navigation.

  4. Added reference type badges to ### subsection headings throughout the customize page, cross-referenced against the ApiReferenceConfiguration schema and individual reference type pages.

  5. Added WebSocket tab examples to the three sections with WebSocket/AsyncAPI badges (Ordering section contents, Styling endpoints, Hiding endpoints), showing WSS /path/name syntax.

  6. Cleaned up reference generation pages: simplified descriptions and introductory text for generate-api-ref.mdx, generate-webhook-ref.mdx, generate-websocket-ref.mdx, and generate-openrpc-ref.mdx. Restructured generate-api-ref.mdx with a Steps component and added a tip about other supported reference types.

  7. Updated navigation titles to use consistent sentence case with "Reference" capitalized (e.g., "Generate REST API Reference", "Customize API Reference layout").

  8. Added redirects for old URLs: endpoint-errors, server-urls, and the generate-api-ref#api-reference-configuration-options anchor.

  9. Updated internal links (changelog entry) and added WSS to Vale style exceptions.

Review & Testing Checklist for Human

  • Verify the preview deployment renders correctly: badges under each ### heading, ParamField components in config section, WebSocket tabs, and endpoint errors section.
  • Verify AsyncAPI badge color — uses <Badge color="teal">AsyncAPI</Badge>. Confirm "teal" is a supported Badge color and renders properly in light/dark mode.
  • Test redirects — Verify the three new redirects resolve correctly, especially the fragment-based redirect (generate-api-ref#api-reference-configuration-optionscustomize-api-reference-layout#configuration-options), which may not be supported by Fern's redirect system.
  • Verify server-urls consolidation — The content from the deleted server-urls.mdx was moved into api-explorer.mdx's "Multiple environments" section. Confirm no content was lost and the environment persistence Loom embed still works.
  • Check WebSocket tab examples — The three new WebSocket tabs use plant-themed endpoints (/plants/live-updates, /plants/growth-monitor). Verify YAML syntax is valid and examples are consistent with doc conventions.

Notes

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

```

[Learn more](/learn/docs/api-references/generate-api-ref#api-reference-configuration-options) about API reference configuration options.
[Learn more](/learn/docs/api-references/customize-api-reference-layout#configuration-options) about API reference configuration options.
Copy link
Contributor

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 Reference' instead of 'API reference'.

@devin-ai-integration devin-ai-integration bot changed the title Move API reference config options and endpoint errors into customize page Restructure API Reference docs: consolidate config, errors, and server URLs Feb 9, 2026
@devalog devalog requested a review from chdeskur February 9, 2026 20:44
</ParamField>

<ParamField path="api-name" toc={true} type="string">
Only used when your project has [multiple APIs](/learn/docs/api-references/generate-api-ref#include-more-than-one-api-reference). The value must match the folder name containing the API definition. Do not set this property if you only have a single API, as it will cause errors.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'don't' instead of 'Do not'.

</ParamField>

<ParamField path="api-name" toc={true} type="string">
Only used when your project has [multiple APIs](/learn/docs/api-references/generate-api-ref#include-more-than-one-api-reference). The value must match the folder name containing the API definition. Do not set this property if you only have a single API, as it will cause errors.
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'don't' instead of 'Do not'.

@devalog devalog merged commit 983686a into main Feb 10, 2026
2 checks passed
@devalog devalog deleted the devin/1770660251-restructure-api-ref-docs branch February 10, 2026 16:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant