Skip to content

docs: add Prompt component page and changelog entry#4863

Open
kgowru wants to merge 3 commits intomainfrom
devin/1774493154-prompt-component-docs
Open

docs: add Prompt component page and changelog entry#4863
kgowru wants to merge 3 commits intomainfrom
devin/1774493154-prompt-component-docs

Conversation

@kgowru
Copy link
Copy Markdown
Contributor

@kgowru kgowru commented Apr 9, 2026

Summary

Adds documentation for the new <Prompt> MDX component (implemented in fern-platform #9605):

  • New page at component-library/default-components/prompt.mdx — usage, variants (copy-only, single open-in, multiple open-in dropdown), and properties reference
  • Navigation entry in docs.yml between "Parameter field" and "Runnable endpoint"
  • Changelog entry for 2026-03-26

Updates since last revision

  • Added a "How it works" section explaining that markdown formatting in prompt children is automatically preserved when copied or opened in an AI tool (powered by the remarkPromptRawContent remark plugin in fern-platform #9605)
  • Updated all examples to use markdown-rich prompt content (bold, links) instead of plain-text URLs, demonstrating the markdown preservation feature
  • Updated children property type from string | ReactNode to markdown and clarified that formatting is preserved
  • Updated changelog entry to mention markdown preservation

Review & Testing Checklist for Human

  • Merge ordering: The fern-platform PR (#9605) with the component implementation must ship before (or alongside) this PR, otherwise the <Prompt> examples won't render
  • Verify example links resolve: Examples reference real pages like https://buildwithfern.com/learn/docs/getting-started/quickstart and https://buildwithfern.com/learn/sdks/generators/typescript/quickstart — confirm these URLs are valid
  • Preview the page in a deploy preview to check layout, especially the new "How it works" section, code block examples, <ParamField> rendering, and <Markdown src="/snippets/agent-directive.mdx"/> inclusion
  • Verify the changelog link /learn/docs/writing-content/components/prompt resolves to the correct page once both PRs are merged

Suggested 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, the "How it works" section reads well, the navigation link appears in the sidebar, and the changelog entry links back to the page.

Notes

  • The component page follows the same structure as existing component pages (Copy, Callout, Icon): frontmatter → agent directive snippet → intro → Usage → Variants → Properties
  • The Prompt entry in docs.yml does not set an explicit slug (unlike parameter-fields), so the auto-generated slug from the filename is used

Link to Devin session: https://app.devin.ai/sessions/20a3aeeb0d50425f8e592b8912861201
Requested by: @kgowru

Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 9, 2026

devalog and others added 2 commits April 10, 2026 13:46
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.

2 participants