docs: add Prompt component page and changelog entry#4863
docs: add Prompt component page and changelog entry#4863
Conversation
Co-Authored-By: Kapil Gowru <k.gowru@gmail.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:
|
|
🌿 Preview your docs: https://fern-preview-devin-1774493154-prompt-component-docs.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
…changes Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
| --- | ||
|
|
There was a problem hiding this comment.
🔴 New changelog page missing required agent directive snippet
The new fern/products/docs/pages/changelog/2026-03-26.mdx file is missing the mandatory <Markdown src="/snippets/agent-directive.mdx"/> line. Per AGENTS.md, every new .mdx page created under fern/products/ must include this directive after the closing --- of the front matter.
| --- | |
| --- | |
| <Markdown src="/snippets/agent-directive.mdx"/> | |
Was this helpful? React with 👍 or 👎 to provide feedback.
Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
|
|
||
| <Markdown src="/snippets/agent-directive.mdx"/> | ||
|
|
||
| The `<Prompt>` component displays an AI prompt card with a title, a single-line prompt preview, a copy button, and optional "Open in" action buttons for AI tools. Add it to any page so readers can quickly copy the instructions or open them directly in Cursor, Claude, or ChatGPT. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'quickly' if it's not important to the meaning of the statement.
Summary
Adds documentation for the new
<Prompt>MDX component (implemented in fern-platform #9605):component-library/default-components/prompt.mdx— usage, variants (copy-only, single open-in, multiple open-in dropdown), "How it works" section on markdown preservation, and properties referencedocs.ymlbetween "Parameter field" and "Runnable endpoint"Updates since last revision
description/icon/iconTypeprops with the newtitleprop>chevron and copy buttontitle,actions,children)remarkPromptRawContentremark plugin)Review & Testing Checklist for Human
2026-03-26.mdx) still referencesdescription,icon, andiconTypeprops which were removed in the component redesign. This needs to be updated to usetitleinstead, and the example should match the new component API — otherwise the live example will break once the fern-platform PR ships<Prompt>examples won't render<ParamField>rendering, and<Markdown src="/snippets/agent-directive.mdx"/>inclusionhttps://buildwithfern.com/learn/docs/getting-started/quickstartandhttps://buildwithfern.com/learn/sdks/generators/typescript/quickstart— confirm these URLs are valid/learn/docs/writing-content/components/promptresolves to the correct page once both PRs are mergedSuggested test plan: After merging fern-platform #9605, deploy a preview of this PR and navigate to the Prompt component page. Verify all example code blocks render the component correctly with the new layout (title, prompt preview bar, action buttons). Check that the changelog example also renders correctly.
Notes
docs.ymldoes not set an explicitslug(unlikeparameter-fields), so the auto-generated slug from the filename is usedfern/products/docs/pages/changelog/2026-03-26.mdxwas not updated during the visual redesign pass — it still uses the olddescription/icon/iconTypeprops rather than the newtitlepropLink to Devin session: https://app.devin.ai/sessions/20a3aeeb0d50425f8e592b8912861201
Requested by: @kgowru