Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Nov 18, 2025

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:

  • Created new documentation page at /learn/docs/developer-tools/code-snippet-package with installation, usage, configuration, and framework integration examples
  • Added page to Developer tools section in navigation
  • Added changelog entry for November 18, 2025
  • Fixed unrelated MDX parse error in CLI changelog (double backtick) that was blocking CI on main branch

The page is marked with a "coming soon" callout and includes comprehensive examples using plant-themed content per documentation guidelines.

Review & Testing Checklist for Human

⚠️ CRITICAL - Verify with feature team:

  • Confirm API surface accuracy - The package name (@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.
  • Verify all internal links work - Test the "Related resources" links in the preview, particularly /docs/api-references/generate-api-ref, /docs/api-references/sdk-snippets, and /learn/api-definitions/overview
  • Confirm navigation placement - Verify "Developer tools" is the right section, or if it should be under "Integrations" or elsewhere
  • Review code examples for technical accuracy - The TypeScript/React examples, environment variable usage, and framework integration patterns should match how the actual package will work

Test plan:

  1. Open the preview link and navigate to Developer tools → Code snippet package
  2. Verify the page renders correctly with all MDX components (Callout, CodeBlocks, Tabs, ParamField)
  3. Check that all internal links resolve correctly
  4. Review the changelog entry at /learn/docs/changelog to ensure it appears properly

Notes

  • Vale warnings about "coming soon" (time-relative term) and "API reference" capitalization are present but non-blocking
  • The unrelated CLI changelog fix (removing double backtick) was necessary to unblock CI and is a safe one-character change
  • Used plant-themed examples throughout per documentation guidelines
  • Local testing confirmed the page renders correctly and the parse error is resolved

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: Local testing

View original video (recording-acb4cd43-b499-4dcb-b817-742003bd0950-edited.mp4)

@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

---

<Callout intent="info">
This feature is coming soon. Check back for updates on availability.
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.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
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'.

## 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
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'.

@@ -0,0 +1,7 @@
## Code snippet package (coming soon)
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.Current] Avoid time-relative terms like 'soon' that become outdated

@github-actions
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot changed the title Add code snippet package documentation page Add code snippet package documentation (coming soon feature) Nov 18, 2025
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

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