Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

Document Runnable Endpoint component and add changelog entry

Summary

This PR adds comprehensive documentation for the Runnable Endpoint component, documenting the improvements made in fern-api/fern-platform#4151. The PR includes:

  1. New component documentation page (runnable-endpoint.mdx) covering:

    • Basic usage and syntax
    • Key features (interactive form builder, multiple examples support, environment selection, request execution, API reference linking, form persistence)
    • Component properties and parameters
    • Architecture overview of the componentized structure
    • Best practices for implementation
  2. Changelog entry for October 17, 2025 highlighting:

    • Componentized architecture improvements
    • New features (multiple examples dropdown, environment selector, "Open in API Reference" button)
    • Enhanced form state persistence
  3. Navigation update to add the new component page to the docs structure

Review & Testing Checklist for Human

  • Verify documentation accuracy: Review the component features and properties against the actual implementation in fern-platform#4151 to ensure all documented behavior is correct
  • Add missing screenshot: The documentation references runnable-endpoint-examples.png which doesn't exist yet - need to capture and add this screenshot showing the example selector
  • Test documentation rendering: Preview the docs locally or in a PR preview to ensure proper rendering, working links, and correct navigation
  • Verify navigation path: Confirm the navigation link works and the page is accessible at the expected URL (/learn/docs/building-and-customizing-your-docs/component-library/runnable-endpoint)
  • Check icon appropriateness: Verify that fa-duotone fa-play-circle is the right icon choice for this component

Test Plan

  1. Run fern docs dev locally to preview the changes
  2. Navigate to the component library section and verify the "Runnable Endpoint" page appears in the correct location
  3. Review all links on the page (especially the changelog link at the bottom)
  4. Check that code examples render correctly in both tabs
  5. Verify the changelog entry displays properly in the changelog section

Notes

  • This documentation was created based on the PR description and code changes from fern-platform#4151, without direct testing of the component functionality
  • The placement in navigation is between "Parameter Fields" and "Steps" which maintains rough alphabetical grouping
  • Requested by Deep Singhvi (@dsinghvi) in Devin session: https://app.devin.ai/sessions/bc9a7d6d33cb44059ac6c2624cce90c0

- Add comprehensive documentation for the Runnable Endpoint component
- Include usage examples, features, properties, and best practices
- Add navigation entry for the new component page
- Create changelog entry for 2025-10-17 documenting the enhancement

This documents the work from PR fern-api/fern-platform#4151 which
improved the Runnable Endpoint component with a componentized
architecture, multiple examples support, environment selector,
and enhanced form persistence.

Co-Authored-By: Deep Singhvi <deep@buildwithfern.com>
@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

Co-Authored-By: Deep Singhvi <deep@buildwithfern.com>
@github-actions
Copy link
Contributor

Per feedback from Catherine, this rewrites the changelog to introduce
the component as a brand new feature rather than framing it as
improvements to an existing component.

Co-Authored-By: Deep Singhvi <deep@buildwithfern.com>
@github-actions
Copy link
Contributor

Add screenshot provided by Catherine showing the Runnable Endpoint
component in action with the example selector dropdown visible.

Co-Authored-By: Deep Singhvi <deep@buildwithfern.com>
@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@github-actions
Copy link
Contributor

@chdeskur chdeskur merged commit e0afedf into main Oct 17, 2025
1 check passed
@chdeskur chdeskur deleted the devin/1760665976-document-runnable-endpoint branch October 17, 2025 18:03
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.

3 participants