docs: add Prompt component page and changelog entry#4863
Open
docs: add Prompt component page and changelog entry#4863
Conversation
Co-Authored-By: Kapil Gowru <k.gowru@gmail.com>
Contributor
🤖 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:
|
Contributor
|
🌿 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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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), and properties referencedocs.ymlbetween "Parameter field" and "Runnable endpoint"Updates since last revision
remarkPromptRawContentremark plugin in fern-platform #9605)childrenproperty type fromstring | ReactNodetomarkdownand clarified that formatting is preservedReview & Testing Checklist for Human
<Prompt>examples won't renderhttps://buildwithfern.com/learn/docs/getting-started/quickstartandhttps://buildwithfern.com/learn/sdks/generators/typescript/quickstart— confirm these URLs are valid<ParamField>rendering, and<Markdown src="/snippets/agent-directive.mdx"/>inclusion/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, the "How it works" section reads well, the navigation link appears in the sidebar, and the changelog entry links back to the page.
Notes
docs.ymldoes not set an explicitslug(unlikeparameter-fields), so the auto-generated slug from the filename is usedLink to Devin session: https://app.devin.ai/sessions/20a3aeeb0d50425f8e592b8912861201
Requested by: @kgowru