-
Notifications
You must be signed in to change notification settings - Fork 4
Add Fern SDKs vs OpenAPI Generator comparison page #2869
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
base: main
Are you sure you want to change the base?
Add Fern SDKs vs OpenAPI Generator comparison page #2869
Conversation
Co-Authored-By: Chris McDonnell <[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:
|
|
|
||
| | Capability | Fern | OpenAPI Generator | | ||
| |------------|------|-------------------| | ||
| | **Documentation** | Comprehensive README + API reference | Minimal (title only) | |
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'.
| <AccordionGroup> | ||
| <Accordion title="Documentation and onboarding" defaultOpen={true}> | ||
|
|
||
| Fern SDKs ship with comprehensive documentation that enables developers to get started quickly without reading generated code. OpenAPI Generator output requires developers to infer usage patterns from the generated files. |
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.Adverbs] Remove 'quickly' if it's not important to the meaning of the statement.
| | Feature | Fern | OpenAPI Generator | | ||
| |---------|------|-------------------| | ||
| | **README** | Comprehensive guide covering installation, auth, types, errors, pagination, retries, timeouts, logging, and runtime compatibility | Minimal (often just a title) | | ||
| | **API reference** | Generated `reference.md` with usage examples for every endpoint | None | |
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'.
|
|
||
| <Accordion title="Runtime compatibility and packaging"> | ||
|
|
||
| Fern explicitly supports multiple JavaScript runtimes and ships with proper ESM/CJS dual builds. OpenAPI Generator has basic module support. |
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.Acronyms] 'ESM' has no definition.
|
|
||
| <Accordion title="Runtime compatibility and packaging"> | ||
|
|
||
| Fern explicitly supports multiple JavaScript runtimes and ships with proper ESM/CJS dual builds. OpenAPI Generator has basic module support. |
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.Acronyms] 'CJS' has no definition.
| | **Bun** | 1.0+ | Not documented | | ||
| | **Cloudflare Workers** | Yes | Not documented | | ||
| | **React Native** | Yes | Not documented | | ||
| | **ESM/CJS builds** | Dual builds with proper exports | Basic ESM/CJS | |
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.Acronyms] 'ESM' has no definition.
| | **Bun** | 1.0+ | Not documented | | ||
| | **Cloudflare Workers** | Yes | Not documented | | ||
| | **React Native** | Yes | Not documented | | ||
| | **ESM/CJS builds** | Dual builds with proper exports | Basic ESM/CJS | |
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.Acronyms] 'CJS' has no definition.
| | **Bun** | 1.0+ | Not documented | | ||
| | **Cloudflare Workers** | Yes | Not documented | | ||
| | **React Native** | Yes | Not documented | | ||
| | **ESM/CJS builds** | Dual builds with proper exports | Basic ESM/CJS | |
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.Acronyms] 'ESM' has no definition.
| | **Bun** | 1.0+ | Not documented | | ||
| | **Cloudflare Workers** | Yes | Not documented | | ||
| | **React Native** | Yes | Not documented | | ||
| | **ESM/CJS builds** | Dual builds with proper exports | Basic ESM/CJS | |
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.Acronyms] 'CJS' has no definition.
Co-Authored-By: Chris McDonnell <[email protected]>
|
|
||
| Fern presents a single unified client with intuitive namespaces that align with how developers think about APIs. OpenAPI Generator requires instantiating separate API classes. | ||
|
|
||
| **Fern SDK:** |
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.
don't use bolded titles like this for a codeblock, instead use this format, here and throughout:
typescript Fern SDK
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| ## Summary |
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.
no need to have a separate summary section. integrate this info into the intro paragraph and delete any excess info (stay concise)
Co-Authored-By: Chris McDonnell <[email protected]>
fern/products/sdks/sdks.yml
Outdated
| - page: Capabilities | ||
| path: ./capabilities.mdx | ||
| slug: capabilities | ||
| - page: Fern SDKs vs OpenAPI Generator |
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.
this should be in a separate section called "Resources" that is at the end and marked as hidden
Co-Authored-By: Chris McDonnell <[email protected]>
|
|
||
| ## Runtime compatibility and packaging | ||
|
|
||
| Fern supports multiple JavaScript runtimes with ESM/CJS dual builds and automatic runtime detection. OpenAPI Generator provides ESM/CJS support. |
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.Acronyms] 'ESM' has no definition.
|
|
||
| ## Runtime compatibility and packaging | ||
|
|
||
| Fern supports multiple JavaScript runtimes with ESM/CJS dual builds and automatic runtime detection. OpenAPI Generator provides ESM/CJS support. |
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.Acronyms] 'CJS' has no definition.
|
|
||
| ## Runtime compatibility and packaging | ||
|
|
||
| Fern supports multiple JavaScript runtimes with ESM/CJS dual builds and automatic runtime detection. OpenAPI Generator provides ESM/CJS support. |
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.Acronyms] 'ESM' has no definition.
|
|
||
| ## Runtime compatibility and packaging | ||
|
|
||
| Fern supports multiple JavaScript runtimes with ESM/CJS dual builds and automatic runtime detection. OpenAPI Generator provides ESM/CJS support. |
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.Acronyms] 'CJS' has no definition.
Summary
Adds a new documentation page comparing Fern-generated SDKs to OpenAPI Generator SDKs. The page is placed in a hidden "Resources" section at the end of the SDKs navigation and covers:
The comparison uses AccordionGroup components with side-by-side code examples and feature comparison tables, following the format established in the existing Stainless comparison page.
Updates since last revision
**Fern SDK:**) to code fence titles (```typescript Fern SDK)Review & Testing Checklist for Human
Recommended test plan: Deploy preview and navigate directly to
/sdks/fern-vs-openapi-generator. Verify the page does NOT appear in the sidebar navigation. Expand each accordion section and verify formatting. Have someone familiar with both tools review for factual accuracy.Notes
stainless-comparison.mdx)Link to Devin run: https://app.devin.ai/sessions/6419d0f32163483496509efaceb528e1
Requested by: Chris McDonnell ([email protected]) / @cdonel707