-
Notifications
You must be signed in to change notification settings - Fork 4
Add code snippet package documentation (coming soon feature) #2100
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 code snippet package documentation (coming soon feature) #2100
Conversation
Co-Authored-By: [email protected] <[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:
|
| --- | ||
|
|
||
| <Callout intent="info"> | ||
| This feature is coming soon. Check back for updates on availability. |
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 'soon' that become outdated
|
|
||
| ## Related resources | ||
|
|
||
| - [Generate API reference](/docs/api-references/generate-api-ref) - Learn about Fern's full API documentation solution |
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'.
| ## Related resources | ||
|
|
||
| - [Generate API reference](/docs/api-references/generate-api-ref) - Learn about Fern's full API documentation solution | ||
| - [SDK snippets](/docs/api-references/sdk-snippets) - Configure code examples in your API reference |
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'.
| @@ -0,0 +1,7 @@ | |||
| ## Code snippet package (coming soon) | |||
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 'soon' that become outdated
…, Next.js first Co-Authored-By: [email protected] <[email protected]>
Add code snippet package documentation (coming soon feature)
Summary
Added documentation for an upcoming standalone npm package that will allow users to embed Fern-generated API route documentation into their existing documentation sites (Docusaurus, GitBook, etc.) without migrating to Fern Docs.
Main changes:
/learn/docs/developer-tools/code-snippet-packagewith installation, usage, configuration, and framework integration examplesThe page is marked with a "coming soon" callout and includes comprehensive examples using plant-themed content per documentation guidelines.
Review & Testing Checklist for Human
@fern-api/code-snippet), component name (FernApiRoute), props, and entire API are assumptions since the feature doesn't exist yet. Review with the team building this feature to ensure alignment with actual implementation plans./docs/api-references/generate-api-ref,/docs/api-references/sdk-snippets, and/learn/api-definitions/overviewTest plan:
/learn/docs/changelogto ensure it appears properlyNotes
Preview URL: https://fern-preview-a7e87ffd-baad-4eb8-964e-fa960c1c2b06.docs.buildwithfern.com/learn
Direct link to new page: https://fern-preview-a7e87ffd-baad-4eb8-964e-fa960c1c2b06.docs.buildwithfern.com/learn/docs/developer-tools/code-snippet-package
Link to Devin run: https://app.devin.ai/sessions/253372c923554b969656e19509d88fba
Requested by: [email protected] (@thesandlord)
Local testing recording:
View original video (recording-acb4cd43-b499-4dcb-b817-742003bd0950-edited.mp4)