-
Notifications
You must be signed in to change notification settings - Fork 6
Restructure API Reference docs: consolidate config, errors, and server URLs #3543
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.
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
Conversation
…page Co-Authored-By: Devin Logan <[email protected]>
🤖 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:
|
| ``` | ||
|
|
||
| [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. |
There was a problem hiding this comment.
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'.
Co-Authored-By: Devin Logan <[email protected]>
…tion headings Co-Authored-By: Devin Logan <[email protected]>
Co-Authored-By: Devin Logan <[email protected]>
Co-Authored-By: Devin Logan <[email protected]>
Co-Authored-By: Devin Logan <[email protected]>
…it-manager.devin.ai/proxy/github.com/fern-api/docs into devin/1770660251-restructure-api-ref-docs
Co-Authored-By: Devin Logan <[email protected]>
| </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. |
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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'.
Restructure API Reference documentation
Summary
Consolidates and reorganizes the API Reference documentation section:
Moved configuration options from
generate-api-ref.mdxintocustomize-api-ref.mdxas a "Configuration options" section usingParamFieldcomponents withBadgetags 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.Merged endpoint errors page into
customize-api-ref.mdxas a "Displaying endpoint errors" subsection. Deleted the standaloneendpoint-errors.mdxand removed it from navigation.Merged server URLs page into
api-explorer.mdxunder the existing "Multiple environments" section. Deleted the standaloneserver-urls.mdxand removed it from navigation.Added reference type badges to
###subsection headings throughout the customize page, cross-referenced against theApiReferenceConfigurationschema and individual reference type pages.Added WebSocket tab examples to the three sections with WebSocket/AsyncAPI badges (Ordering section contents, Styling endpoints, Hiding endpoints), showing
WSS /path/namesyntax.Cleaned up reference generation pages: simplified descriptions and introductory text for
generate-api-ref.mdx,generate-webhook-ref.mdx,generate-websocket-ref.mdx, andgenerate-openrpc-ref.mdx. Restructuredgenerate-api-ref.mdxwith aStepscomponent and added a tip about other supported reference types.Updated navigation titles to use consistent sentence case with "Reference" capitalized (e.g., "Generate REST API Reference", "Customize API Reference layout").
Added redirects for old URLs:
endpoint-errors,server-urls, and thegenerate-api-ref#api-reference-configuration-optionsanchor.Updated internal links (changelog entry) and added
WSSto Vale style exceptions.Review & Testing Checklist for Human
###heading, ParamField components in config section, WebSocket tabs, and endpoint errors section.<Badge color="teal">AsyncAPI</Badge>. Confirm "teal" is a supported Badge color and renders properly in light/dark mode.generate-api-ref#api-reference-configuration-options→customize-api-reference-layout#configuration-options), which may not be supported by Fern's redirect system.server-urls.mdxwas moved into api-explorer.mdx's "Multiple environments" section. Confirm no content was lost and the environment persistence Loom embed still works./plants/live-updates,/plants/growth-monitor). Verify YAML syntax is valid and examples are consistent with doc conventions.Notes