-
Notifications
You must be signed in to change notification settings - Fork 3
Update Fern Editor page and Swift launch #947
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
107a0ec
feat: udpating ve
07e646f
feat: udpating ve
d1d6918
feat: udpating ve & swift generator
100d32e
feat: udpating ve & swift generator
786f6e1
feat: udpating ve & swift generator
e40f222
feat: udpating ve & swift generator
3336e33
feat: udpating ve & swift generator
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,5 @@ | ||
| ## 0.78.4 | ||
| **`(fix):`** Collapse any combination of optional and nullable to optional<nullable<T>>. | ||
| **`(fix):`** Collapse any combination of optional and nullable to `optional<nullable<T>>`. | ||
|
|
||
| ## 0.78.3 | ||
| **`(chore):`** Support IR v59 in the Rust SDK generator. | ||
|
|
||
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
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
Binary file added
BIN
+161 KB
fern/products/docs/pages/component-library/writing-content/visual-editor.avif
Binary file not shown.
170 changes: 95 additions & 75 deletions
170
fern/products/docs/pages/component-library/writing-content/visual-editor.mdx
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,86 +1,106 @@ | ||
| --- | ||
| title: Visual Editor | ||
| description: Edit your docs visually, no code required | ||
| title: Fern Editor | ||
| description: Update your docs visually with a GitHub-backed workflow that creates pull requests. | ||
| --- | ||
|
|
||
| <Note> | ||
| The Visual Editor is in development. Interested in early access? Reach out via Slack or support@buildwithfern.com. | ||
| </Note> | ||
|
|
||
| The Fern Visual Editor lets you modify your documentation without touching code. Make changes directly in your browser while maintaining your Git-based workflow. | ||
| Fern Editor lets anyone on your team update documentation without learning code, markdown, or Git. Perfect for non-technical teammates like content writers, product managers, and marketers who want to contribute to docs without needing developer setup. | ||
|
|
||
| <Frame | ||
| caption="Edit your docs visually with our WYSIWYG editor" | ||
| caption="Edit your docs visually with Fern Editor" | ||
| background="subtle" | ||
| > | ||
| <img src="./visual-editor.png" /> | ||
| <img src="./visual-editor.avif" /> | ||
| </Frame> | ||
|
|
||
| ## Key Features | ||
|
|
||
| ### No-Code Editing | ||
| Edit your documentation directly in the browser - no GitHub knowledge required. Every change you make is automatically synced. | ||
|
|
||
| ### Component Library | ||
| You can directly edit or use the slash (`/`) menu to add Fern components to your documentation. | ||
|
|
||
| <Tabs> | ||
| <Tab title="Layout Components"> | ||
| <Card> | ||
| - [Tabs](/learn/docs/content/components/tabs) for organizing related content | ||
| - [Accordion](/learn/docs/content/components/accordions) for expandable sections | ||
| - [AccordionGroup](/learn/docs/content/components/accordion-groups) for grouped expandable content | ||
| - [Card](/learn/docs/content/components/cards) for highlighting information | ||
| - [Frame](/learn/docs/content/components/frames) for images and examples | ||
| - [Steps](/learn/docs/content/components/steps) for sequential instructions | ||
| </Card> | ||
| </Tab> | ||
|
|
||
| <Tab title="Content Components"> | ||
| <Card> | ||
| - [Note](/learn/docs/content/components/callouts) for important callouts | ||
| - [Warning](/learn/docs/content/components/callouts) for critical information | ||
| - [Tip](/learn/docs/content/components/callouts) for helpful suggestions | ||
| - [Info](/learn/docs/content/components/callouts) for additional context | ||
| - [Code Groups](/learn/docs/content/components/code-blocks) for related code examples | ||
| - [Code Blocks](/learn/docs/content/components/code-blocks) for code snippets | ||
| - [Embed](/learn/docs/content/components/embed) for external content | ||
| </Card> | ||
| </Tab> | ||
|
|
||
| <Tab title="API Components"> | ||
| <Card> | ||
| - [Parameter Fields](/learn/docs/content/components/paramfield) for parameter details | ||
| - [Endpoint Request Snippet](/learn/docs/content/components/request-snippet) for request documentation | ||
| - [Endpoint Response Snippet](/learn/docs/content/components/response-snippet) for response documentation | ||
| </Card> | ||
| </Tab> | ||
| </Tabs> | ||
|
|
||
| ## Getting Started | ||
|
|
||
| <Steps> | ||
| <Step title="Access the Editor"> | ||
| Navigate to your Fern Dashboard (_coming soon_) and click the "Edit docs site" button in the top navigation bar. | ||
| </Step> | ||
| <a className="fern-card interactive not-prose rounded-3 relative block border p-6 text-base fe-action-button" href="https://dashboard.buildwithfern.com/"> | ||
| ## Try it now | ||
| <Button intent="primary" rightIcon="arrow-right"> | ||
| Open Dashboard | ||
| </Button> | ||
| </a> | ||
|
|
||
| ## Key features | ||
|
|
||
| <CardGroup cols={2}> | ||
| <Card title="Expressive rich text" icon="duotone edit"> | ||
| Write and edit like you would in Notion or Google Docs—no markdown or code required | ||
| </Card> | ||
|
|
||
| <Card title="Fern components support" icon="duotone puzzle-piece"> | ||
| Create and edit Callouts, Cards, etc directly from UI, with more components coming soon ✨ | ||
| </Card> | ||
|
|
||
| <Card title="GitHub-backed workflow" icon="duotone code-compare"> | ||
| Maintains docs-as-code approach with Git history and review process—making content easily consumable by AI tools | ||
| </Card> | ||
|
|
||
| <Card title="Dev mode" icon="duotone code"> | ||
| Fully customize your site's source code from the editor when you need a little more control | ||
| </Card> | ||
|
|
||
| <Card title="[Beta] Images & videos" icon="duotone image"> | ||
| Drag & drop to upload media to your site, with full support for Git-backed files coming soon | ||
| </Card> | ||
|
|
||
| <Card title="[Beta] Create new pages" icon="duotone file-plus"> | ||
| Create/delete new pages from the editor, with more features for organizing the navigation structure of your site coming soon | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
| ## FAQ | ||
|
|
||
| <AccordionGroup> | ||
| <Accordion title="What are the supported components?"> | ||
| <br /> | ||
|
|
||
| <Step title="Make Changes"> | ||
| - Select text to format it or add links | ||
| - Use the `/` menu to add Fern components | ||
| - Preview your changes in real-time | ||
| - Add images and media | ||
| </Step> | ||
| | Component | Support Status | | ||
| | --- | --- | | ||
| | [Accordions](/learn/docs/content/components/accordions) | Supported | | ||
| | [Accordion Groups](/learn/docs/content/components/accordion-groups) | Supported | | ||
| | [Aside](/learn/docs/content/components/aside) | Coming soon | | ||
| | [Button](/learn/docs/content/components/button) | Coming soon | | ||
| | [Callouts](/learn/docs/content/components/callouts) | Supported | | ||
| | [Cards](/learn/docs/content/components/cards) | Supported | | ||
| | [Card Groups](/learn/docs/content/components/card-groups) | Supported | | ||
| | [Code Blocks](/learn/docs/content/components/code-blocks) | Supported | | ||
| | [Embed](/learn/docs/content/components/embed) | Coming soon | | ||
| | [Endpoint Request Snippet](/learn/docs/content/components/request-snippet) | Coming soon | | ||
| | [Endpoint Response Snippet](/learn/docs/content/components/response-snippet) | Coming soon | | ||
| | [Endpoint Schema Snippet](/learn/docs/content/components/schema-snippet) | Coming soon | | ||
| | [Frames](/learn/docs/content/components/frames) | Coming soon | | ||
| | [Icons](/learn/docs/content/components/icons) | Coming soon | | ||
| | [Parameter Fields](/learn/docs/content/components/parameter-fields) | Supported | | ||
| | [Steps](/learn/docs/content/components/steps) | Supported | | ||
| | [Sticky tables](/learn/docs/content/components/sticky-tables) | Coming soon | | ||
| | [Tabs](/learn/docs/content/components/tabs) | Supported | | ||
| | [Sticky tables](/learn/docs/content/components/sticky-tables) | Coming soon | | ||
| | [Tooltips](/learn/docs/content/components/tooltips) | Coming soon | | ||
|
|
||
| <Step title="Submit Changes"> | ||
| Your changes are automatically saved as drafts. When ready: | ||
| 1. Review your changes | ||
| 2. Add a description of your updates | ||
| 3. Click "Publish" to create a pull request in Github | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| <Note> | ||
| All changes go through your normal GitHub workflow - maintaining your team's review process while making editing accessible to everyone. | ||
| </Note> | ||
|
|
||
| Ready to get started? Reach out to support@buildwithfern.com. | ||
| <br /> | ||
| </Accordion> | ||
|
|
||
| <Accordion title="How is 'What You See Is What You Get' related to Fern Editor?"> | ||
| "What You See Is What You Get" (WYSIWYG) is a common term for visual editing. Fern Editor is our visual editor - same idea, clearer name. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Why is a GitHub‑backed editor important?"> | ||
| Your changes become pull requests. That means code review, auditability, CI checks, and merge control with branch protections - no surprises in production. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Does Fern Editor support all components?"> | ||
| Yes. Fern Editor supports all built‑in components. See the full list here: [components overview](https://buildwithfern.com/learn/docs/writing-content/components/overview). | ||
| </Accordion> | ||
|
|
||
| <Accordion title="Can I use Fern Editor without local setup or CLI?"> | ||
| Yes. Edit directly in the browser - no local environment required. Your GitHub PR keeps your normal review and CI process. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="How do I start using Fern Editor?"> | ||
| Log in to the [Dashboard](https://dashboard.buildwithfern.com/), connect GitHub, then open Fern Editor from the top navigation. | ||
| </Accordion> | ||
|
|
||
| <Accordion title="What browsers and devices does Fern Editor support?"> | ||
| Currently supports modern Chromium browsers on desktop only. Mobile editing and other browsers coming soon. | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
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
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this will come back later but OK for this PR
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wasn't able to run locally till this was fixed.