-
Notifications
You must be signed in to change notification settings - Fork 3
feat(docs): add Stainless vs Fern comparison pages as hidden resources #1817
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
- Add comprehensive comparison document (stainless-comparison-full.mdx) - Add concise summary comparison (stainless-comparison-summary.mdx) - Mark both pages as hidden in docs.yml navigation - Pages accessible only via direct link for sales engineering use Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
🤖 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:
|
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.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
fern/products/docs/pages/resources/stainless-comparison-summary.mdx|111 col 5| [FernStyles.Headings] 'Fern Resources' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-summary.mdx|120 col 5| [FernStyles.Headings] 'Stainless Resources' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-summary.mdx|127 col 4| [FernStyles.Headings] 'Bottom Line' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-summary.mdx|131 col 54| [FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
fern/products/docs/pages/resources/stainless-comparison-full.mdx|6 col 3| [FernStyles.Headings] 'Stainless Docs vs Fern Docs: Enterprise Feature Comparison' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|8 col 4| [FernStyles.Headings] 'Executive Summary' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|16 col 6| [FernStyles.Reject] Use 'Fern Editor' instead of 'Visual Editor'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|22 col 151| [Microsoft.Auto] In general, don't hyphenate 'auto-populated'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|24 col 78| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|24 col 175| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|28 col 123| [Microsoft.Auto] In general, don't hyphenate 'auto-generation'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|28 col 187| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|32 col 53| [FernStyles.Acronyms] 'VPC' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|36 col 4| [FernStyles.Headings] 'Detailed Feature Comparison' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|38 col 5| [FernStyles.Headings] '1. Platform Maturity and Stability' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|48 col 94| [FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
fern/products/docs/pages/resources/stainless-comparison-full.mdx|51 col 29| [Microsoft.Contractions] Use 'isn't' instead of 'is not'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|55 col 5| [FernStyles.Headings] '2. Content Authoring and Governance' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|80 col 5| [Microsoft.Auto] In general, don't hyphenate 'Auto-Populated'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|96 col 5| [FernStyles.Headings] '4. RBAC, Versioning, and Multi-Product Support' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|112 col 29| [Microsoft.Contractions] Use 'can't' instead of 'cannot'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|122 col 5| [FernStyles.Headings] '5. AI-Powered Search and Assistance' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|126 col 54| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|130 col 22| [Microsoft.Auto] In general, don't hyphenate 'Auto-generated'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|140 col 75| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|148 col 24| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|152 col 5| [FernStyles.Headings] '6. Authentication and Security' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|156 col 16| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|156 col 44| [FernStyles.Acronyms] 'SCIM' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|159 col 30| [Microsoft.Auto] In general, don't hyphenate 'Auto-populate'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|166 col 222| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|174 col 5| [FernStyles.Headings] '7. Hosting and Deployment' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|178 col 41| [FernStyles.Acronyms] 'VPC' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|178 col 45| [Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|184 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|196 col 17| [FernStyles.Acronyms] 'CORS' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|198 col 102| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|202 col 5| [FernStyles.Headings] '8. Redirects, SEO, and Large-Site Operations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|209 col 48| [FernStyles.Acronyms] 'RSS' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|229 col 5| [FernStyles.Headings] '9. Analytics and Observability' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|248 col 28| [Microsoft.Contractions] Use 'can't' instead of 'cannot'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|264 col 22| [Microsoft.Auto] In general, don't hyphenate 'Auto-generated'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|266 col 40| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|276 col 5| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|283 col 4| [FernStyles.Headings] 'Technology Stack Comparison' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|286 col 38| [FernStyles.Acronyms] 'SSR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|286 col 42| [FernStyles.Acronyms] 'SSG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|287 col 5| [Microsoft.Avoid] Don't use 'Backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|287 col 45| [FernStyles.Acronyms] 'VPC' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|295 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|301 col 5| [Microsoft.Avoid] Don't use 'Backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|307 col 11| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|309 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|315 col 4| [FernStyles.Headings] 'Use Case Recommendations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|317 col 5| [FernStyles.Headings] 'Choose Fern Docs When:' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|318 col 48| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|325 col 63| [Microsoft.Wordiness] Consider using 'also' instead of 'in addition'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|329 col 5| [FernStyles.Headings] 'Choose Stainless Docs When:' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|333 col 66| [Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|343 col 4| [FernStyles.Headings] 'Migration Considerations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|352 col 5| [FernStyles.Headings] 'Migrating from Other Platforms to Fern' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|357 col 34| [FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|361 col 4| [FernStyles.Headings] 'Pricing Considerations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|366 col 81| [FernStyles.Acronyms] 'SLA' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|377 col 199| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|381 col 52| [FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
fern/products/docs/pages/resources/stainless-comparison-full.mdx|385 col 4| [FernStyles.Headings] 'Additional Resources' should use sentence-style capitalization.
| description: Concise comparison highlighting enterprise feature gaps between Stainless Docs and Fern Docs | ||
| --- | ||
|
|
||
| # Stainless Docs vs Fern Docs: Quick Comparison |
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.Headings] 'Stainless Docs vs Fern Docs: Quick Comparison' should use sentence-style capitalization.
|
|
||
| # Stainless Docs vs Fern Docs: Quick Comparison | ||
|
|
||
| ## TL;DR |
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.Headings] 'TL;DR' should use sentence-style capitalization.
|
|
||
| --- | ||
|
|
||
| ## Top 10 Enterprise Gaps Where Stainless Falls Short |
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.Headings] 'Top 10 Enterprise Gaps Where Stainless Falls Short' should use sentence-style capitalization.
|
|
||
| ## Top 10 Enterprise Gaps Where Stainless Falls Short | ||
|
|
||
| ### 1. Platform Maturity ⚠️ |
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.Headings] '1. Platform Maturity
| - **Fern**: Production-ready, stable, widely deployed | ||
| - **Impact**: Stainless not suitable for mission-critical documentation | ||
|
|
||
| ### 2. Visual Editor & Non-Technical Authors ❌ |
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.Headings] '2. Visual Editor & Non-Technical Authors ❌' should use sentence-style capitalization.
|
|
||
| --- | ||
|
|
||
| ## When to Choose Each |
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.Headings] 'When to Choose Each' should use sentence-style capitalization.
|
|
||
| ## When to Choose Each | ||
|
|
||
| ### Choose Fern When: |
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.Headings] 'Choose Fern When:' should use sentence-style capitalization.
| ## When to Choose Each | ||
|
|
||
| ### Choose Fern When: | ||
| - ✅ Enterprise requirements (RBAC, SSO, versioning) |
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] 'SSO' has no definition.
| - ✅ Large-scale documentation (100+ pages) | ||
| - ✅ Multi-product or multi-version APIs | ||
|
|
||
| ### Choose Stainless When: |
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.Headings] 'Choose Stainless When:' should use sentence-style capitalization.
|
|
||
| --- | ||
|
|
||
| ## Key Links |
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.Headings] 'Key Links' should use sentence-style capitalization.
- Use sentence-style capitalization for all headings - Replace 'Visual Editor' with 'Fern Editor' - Replace 'Cannot' with 'can't' for contractions Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
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.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
fern/products/docs/pages/resources/stainless-comparison-full.mdx|166 col 222| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|174 col 5| [FernStyles.Headings] '7. Hosting and Deployment' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|178 col 41| [FernStyles.Acronyms] 'VPC' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|178 col 45| [Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|184 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|196 col 17| [FernStyles.Acronyms] 'CORS' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|198 col 102| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|202 col 5| [FernStyles.Headings] '8. Redirects, SEO, and Large-Site Operations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|209 col 48| [FernStyles.Acronyms] 'RSS' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|229 col 5| [FernStyles.Headings] '9. Analytics and Observability' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|248 col 28| [Microsoft.Contractions] Use 'can't' instead of 'cannot'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|264 col 22| [Microsoft.Auto] In general, don't hyphenate 'Auto-generated'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|266 col 40| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|276 col 5| [FernStyles.Acronyms] 'FDR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|283 col 4| [FernStyles.Headings] 'Technology Stack Comparison' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|286 col 38| [FernStyles.Acronyms] 'SSR' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|286 col 42| [FernStyles.Acronyms] 'SSG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|287 col 5| [Microsoft.Avoid] Don't use 'Backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|287 col 45| [FernStyles.Acronyms] 'VPC' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|295 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|301 col 5| [Microsoft.Avoid] Don't use 'Backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|307 col 11| [FernStyles.Acronyms] 'RAG' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|309 col 5| [FernStyles.Acronyms] 'CDN' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|315 col 4| [FernStyles.Headings] 'Use Case Recommendations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|317 col 5| [FernStyles.Headings] 'Choose Fern Docs When:' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|318 col 48| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|325 col 63| [Microsoft.Wordiness] Consider using 'also' instead of 'in addition'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|329 col 5| [FernStyles.Headings] 'Choose Stainless Docs When:' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|333 col 66| [Microsoft.Avoid] Don't use 'backend'. See the A-Z word list for details.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|343 col 4| [FernStyles.Headings] 'Migration Considerations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|352 col 5| [FernStyles.Headings] 'Migrating from Other Platforms to Fern' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|357 col 34| [FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|361 col 4| [FernStyles.Headings] 'Pricing Considerations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|366 col 81| [FernStyles.Acronyms] 'SLA' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|377 col 199| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|381 col 52| [FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
fern/products/docs/pages/resources/stainless-comparison-full.mdx|385 col 4| [FernStyles.Headings] 'Additional Resources' should use sentence-style capitalization.
| - **Fern**: First-class versioning with availability states | ||
| - **Impact**: Can't maintain multiple API versions simultaneously | ||
|
|
||
| ### 5. Interactive API explorer ❌ |
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 Explorer' instead of 'API explorer'.
| - **Fern**: OpenAPI, AsyncAPI, gRPC, OpenRPC, Fern spec | ||
| - **Impact**: Limited to REST APIs, no event-driven or RPC support | ||
|
|
||
| ### 10. Advanced redirects & SEO ❌ |
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.Headings] '10. Advanced redirects & SEO ❌' should use sentence-style capitalization.
| - ✅ Large-scale documentation (100+ pages) | ||
| - ✅ Multi-product or multi-version APIs | ||
|
|
||
| ### Choose Stainless when: |
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.Headings] 'Choose Stainless when:' should use sentence-style capitalization.
|
|
||
| **Fern Docs** is the enterprise-ready choice with production stability, comprehensive features, and robust infrastructure. **Stainless Docs** shows promise but remains in early access with critical feature gaps for enterprise deployments. | ||
|
|
||
| For organizations evaluating documentation platforms today, Fern provides the maturity, features, and support required for mission-critical API documentation. |
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.
[FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
| description: Comprehensive enterprise feature comparison between Stainless Docs and Fern Docs platforms | ||
| --- | ||
|
|
||
| # Stainless Docs vs Fern Docs: Enterprise Feature Comparison |
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.Headings] 'Stainless Docs vs Fern Docs: Enterprise Feature Comparison' should use sentence-style capitalization.
| - **Analytics** identify documentation gaps based on unanswered questions | ||
| - **MCP server** enables AI coding assistants to access your docs programmatically | ||
|
|
||
| Stainless offers basic RAG search without the operational controls needed for enterprise deployments where answer accuracy and compliance are critical. |
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] 'RAG' has no definition.
|
|
||
| --- | ||
|
|
||
| ### 6. Authentication and Security |
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.Headings] '6. Authentication and Security' should use sentence-style capitalization.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **Enterprise SSO** | ✅ WorkOS (SAML/OIDC/SCIM) | ❌ Not documented | |
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] 'SSO' has no definition.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **Enterprise SSO** | ✅ WorkOS (SAML/OIDC/SCIM) | ❌ Not documented | |
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] 'SCIM' has no definition.
| | **Enterprise SSO** | ✅ WorkOS (SAML/OIDC/SCIM) | ❌ Not documented | | ||
| | **Role-Based Access** | ✅ Audience-based content gating | ❌ Not documented | | ||
| | **Authenticated Pages** | ✅ Login-protected documentation | ❌ Not documented | | ||
| | **API Key Management** | ✅ Auto-populate in explorer | ⚠️ API keys for Stainless service 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 🐶
[Microsoft.Auto] In general, don't hyphenate 'Auto-populate'.
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.
Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit
vale
fern/products/docs/pages/resources/stainless-comparison-full.mdx|352 col 5| [FernStyles.Headings] 'Migrating from Other Platforms to Fern' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|357 col 34| [FernStyles.Reject] Use 'API Reference' instead of 'API reference'.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|361 col 4| [FernStyles.Headings] 'Pricing Considerations' should use sentence-style capitalization.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|366 col 81| [FernStyles.Acronyms] 'SLA' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|377 col 199| [FernStyles.Acronyms] 'SSO' has no definition.
fern/products/docs/pages/resources/stainless-comparison-full.mdx|381 col 52| [FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
fern/products/docs/pages/resources/stainless-comparison-full.mdx|385 col 4| [FernStyles.Headings] 'Additional Resources' should use sentence-style capitalization.
| - Fern WorkOS: https://buildwithfern.com/learn/docs/getting-started/how-fern-docs-work (WorkOS integration) | ||
| - Stainless Auth: https://www.stainless.com/docs/docs-platform/advanced/stainless-authentication/ - Only API keys for their service | ||
|
|
||
| **Gap Analysis:** Stainless's "authentication" refers to API keys for accessing their documentation generation service, not end-user authentication for viewing documentation. Fern's WorkOS integration provides enterprise SSO, enabling: |
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] 'SSO' has no definition.
|
|
||
| --- | ||
|
|
||
| ### 7. Hosting and Deployment |
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.Headings] '7. Hosting and Deployment' should use sentence-style capitalization.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **Cloud Hosting** | ✅ Vercel with AWS VPC backend | ✅ Cloudflare (default) | |
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] 'VPC' has no definition.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **Cloud Hosting** | ✅ Vercel with AWS VPC backend | ✅ Cloudflare (default) | |
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.Avoid] Don't use 'backend'. See the A-Z word list for details.
| | **Object Storage** | ✅ S3/MinIO in self-hosted | ❌ Not applicable | | ||
| | **Search Engine** | ✅ MeiliSearch in self-hosted | ❌ Not applicable | | ||
| | **Custom Domains** | ✅ Full support | ✅ Full support | | ||
| | **CDN Integration** | ✅ Cloudflare + Vercel Edge | ✅ Cloudflare | |
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] 'CDN' has no definition.
| ## Use Case Recommendations | ||
|
|
||
| ### Choose Fern Docs When: | ||
| 1. **Enterprise Requirements**: You need RBAC, SSO, versioning, or multi-product documentation |
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] 'SSO' has no definition.
| 5. **Advanced AI**: You need operational controls over AI answers (guidance docs, custom sources) | ||
| 6. **Large-Scale Sites**: You're managing complex documentation with hundreds of pages and redirects | ||
| 7. **Analytics-Driven**: You want data on documentation usage and content gaps | ||
| 8. **Multi-Spec Support**: You use AsyncAPI, gRPC, or OpenRPC in addition to OpenAPI |
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.Wordiness] Consider using 'also' instead of 'in addition'.
| 9. **Production Stability**: You need a stable, battle-tested platform with backward compatibility | ||
| 10. **Comprehensive Support**: You want white-glove migration and ongoing support | ||
|
|
||
| ### Choose Stainless Docs When: |
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.Headings] 'Choose Stainless Docs When:' should use sentence-style capitalization.
| 1. **Early Adopter**: You're comfortable with early access software and breaking changes | ||
| 2. **Simple Documentation**: You have straightforward documentation needs without versioning or RBAC | ||
| 3. **Astro Expertise**: Your team prefers Astro and wants deep customization control | ||
| 4. **Static Hosting**: You only need static file hosting without backend services |
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.Avoid] Don't use 'backend'. See the A-Z word list for details.
|
|
||
| --- | ||
|
|
||
| ## Migration Considerations |
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.Headings] 'Migration Considerations' should use sentence-style capitalization.
- Add CardGroup with icons for top 10 enterprise gaps in summary - Convert detailed feature sections to Accordions in full document - Add Info, Success, Warning, and Launch callouts throughout - Enhance key links section with Cards for better organization - Improve visual hierarchy and readability with collapsible sections - Make documents more digestible and scannable for sales engineering use Co-Authored-By: Chris McDonnell <chris@buildwithfern.com>
| **Impact**: Developers must use external tools (Postman, curl) | ||
| </Card> | ||
|
|
||
| <Card title="6. Enterprise SSO" icon="key"> |
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] 'SSO' has no definition.
| </Card> | ||
|
|
||
| <Card title="8. AI operational controls" icon="robot"> | ||
| **Stainless**: Basic RAG search |
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] 'RAG' has no definition.
|
|
||
| <AccordionGroup> | ||
| <Accordion title="Choose Fern when" defaultOpen={true}> | ||
| <Success>Enterprise requirements (RBAC, SSO, versioning)</Success> |
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] 'SSO' has no definition.
|
|
||
| </Accordion> | ||
|
|
||
| <Accordion title="3. API reference and interactive testing"> |
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'.
| - **Redirects**: Fern's redirect system can maintain URL compatibility | ||
| - **Timeline**: Fern offers white-glove migration service for Enterprise customers | ||
|
|
||
| ### Migrating from Other Platforms to Fern |
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.Headings] 'Migrating from Other Platforms to Fern' should use sentence-style capitalization.
|
|
||
| --- | ||
|
|
||
| ## Pricing Considerations |
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.Headings] 'Pricing Considerations' should use sentence-style capitalization.
| ### Fern Docs | ||
| - **Starter**: Free tier available | ||
| - **Pro**: Usage-based pricing | ||
| - **Enterprise**: Custom pricing with white-glove migration, dedicated support, SLA |
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] 'SLA' has no definition.
| ## Conclusion | ||
|
|
||
| <Launch> | ||
| **Fern Docs is the clear choice for enterprise organizations** requiring production-ready documentation with advanced features like RBAC, versioning, interactive API testing, visual editing, enterprise SSO, and full-stack self-hosting. The platform's maturity, comprehensive feature set, and robust infrastructure make it suitable for mission-critical documentation at scale. |
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] 'SSO' has no definition.
|
|
||
| **Stainless Docs Platform shows promise** with its Astro-based architecture and SDK-native approach, but remains in early access with significant feature gaps for enterprise deployments. Organizations should wait for Stainless to reach production maturity before considering it for critical documentation needs. | ||
|
|
||
| **For enterprises evaluating documentation platforms today**, Fern Docs provides the stability, features, and support required for successful API documentation programs. |
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.
[FernStyles.Current] Avoid time-relative terms like 'today' that become outdated
|
|
||
| --- | ||
|
|
||
| ## Additional Resources |
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.Headings] 'Additional Resources' should use sentence-style capitalization.
| |------------|------|-----------| | ||
| | **Maturity** | Production-ready, stable APIs | Early access, breaking changes expected | | ||
| | **Authoring** | [Visual editor](/learn/docs/writing-content/fern-editor) + Git | Git only | | ||
| | **Enterprise features** | [RBAC](/learn/docs/authentication/rbac), [SSO](/learn/docs/authentication/sso), [versioning](/learn/docs/configuration/what-is-docs-yml) | 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.Acronyms] 'SSO' has no definition.
|
|
||
| <Accordion title="API reference and interactive testing"> | ||
|
|
||
| Stainless does not provide an interactive testing environment. Fern's [API Explorer](/learn/docs/api-references/api-explorer/overview) enables in-browser endpoint testing with automatic credential injection. |
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 'doesn't' instead of 'does not'.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **API explorer** | ✅ [Full playground](/learn/docs/api-references/api-explorer/overview) with [auto-populated credentials](/learn/docs/api-references/autopopulate-api-key), WebSocket, and audio streaming support | ❌ 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 Explorer' instead of 'API explorer'.
|
|
||
| | Feature | Fern Docs | Stainless Docs | | ||
| |---------|-----------|----------------| | ||
| | **API explorer** | ✅ [Full playground](/learn/docs/api-references/api-explorer/overview) with [auto-populated credentials](/learn/docs/api-references/autopopulate-api-key), WebSocket, and audio streaming support | ❌ 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 🐶
[Microsoft.Auto] In general, don't hyphenate 'auto-populated'.
|
|
||
| <Accordion title="RBAC, versioning, and multi-product support"> | ||
|
|
||
| Stainless does not currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/what-is-docs-yml) capabilities for complex API portfolios. |
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 'doesn't' instead of 'does not'.
| | Component | Fern Docs | Stainless Docs | | ||
| |-----------|-----------|----------------| | ||
| | **Frontend** | Next.js (React) with SSR/SSG | Astro (static site generator) | | ||
| | **Backend** | Node.js/Express (FDR) on AWS VPC | Stainless API service | |
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.Avoid] Don't use 'Backend'. See the A-Z word list for details.
| | Component | Fern Docs | Stainless Docs | | ||
| |-----------|-----------|----------------| | ||
| | **Frontend** | Next.js (React) with SSR/SSG | Astro (static site generator) | | ||
| | **Backend** | Node.js/Express (FDR) on AWS VPC | Stainless API service | |
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] 'VPC' has no definition.
| | **Frontend** | Next.js (React) with SSR/SSG | Astro (static site generator) | | ||
| | **Backend** | Node.js/Express (FDR) on AWS VPC | Stainless API service | | ||
| | **Database** | PostgreSQL | Not applicable (static) | | ||
| | **Cache** | Redis, Vercel KV (Upstash) | Cloudflare CDN | |
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] 'CDN' has no definition.
| | **Storage** | S3 (AWS/MinIO) | Not applicable (static) | | ||
| | **Search** | Algolia, MeiliSearch (self-hosted) | Metadata-driven indexing | | ||
| | **Vector database** | TurboPuffer | None | | ||
| | **AI** | Bedrock, Claude, Cohere | RAG with LLM (provider not specified) | |
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] 'RAG' has no definition.
| | **Vector database** | TurboPuffer | None | | ||
| | **AI** | Bedrock, Claude, Cohere | RAG with LLM (provider not specified) | | ||
| | **Authentication** | WorkOS | API keys (for Stainless service) | | ||
| | **CDN** | Cloudflare + Vercel Edge | Cloudflare | |
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] 'CDN' has no definition.
|
|
||
| <Accordion title="RBAC, versioning, and multi-product support"> | ||
|
|
||
| Stainless doesn't currently offer audience-specific content filtering, multi-version APIs, or unified multi-product sites. Fern provides [RBAC](/learn/docs/authentication/rbac) and [versioning](/learn/docs/configuration/what-is-docs-yml) capabilities for complex API portfolios. |
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.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
|
|
||
| <Accordion title="Redirects, SEO, and large-site operations"> | ||
|
|
||
| Stainless doesn't currently document redirect capabilities. Fern's [redirect system](/learn/docs/seo/redirects) supports pattern matching and hundreds of rules for content migrations and reorganization. |
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.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
|
|
||
| <Accordion title="Analytics and observability"> | ||
|
|
||
| Stainless doesn't currently document built-in analytics capabilities. Fern provides [analytics integrations](/learn/docs/integrations/overview) for page visits, search queries, AI chat insights, and user journeys. |
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.
[FernStyles.Current] Avoid time-relative terms like 'currently' that become outdated
Add Stainless vs Fern comparison pages with enhanced visual components
Summary
Added two competitive comparison documents (full detailed version and concise summary) between Stainless Docs and Fern Docs as hidden pages in the documentation. These pages are designed for sales engineering use and are only accessible via direct link.
Key changes:
hidden: trueflag (not visible in navigation/search)Direct URLs:
Review & Testing Checklist for Human
Test Plan
Notes
Session: https://app.devin.ai/sessions/c80b7907999a45189cc33cc83a139884
Requested by: Chris McDonnell (@cdonel707)