Enhance Scribe docs with Fern components and simplified architecture #2054
+65
−5
Conversation
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
Contributor
Author
🤖 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:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| </Note> | ||
|
|
||
| Fern Scribe is a technical writing agent that keeps your docs aligned as your product evolves. | ||
| Fern Scribe is a technical writing agent that keeps your documentation aligned with a constantly-changing product. Instead of relying on engineers or writers to notice every change, Scribe proactively identifies updates across your engineering tools and drafts accurate, high-quality documentation changes. |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Hyphens] 'constantly-changing' doesn't need a hyphen.
| Scribe opens pull requests with either ready-to-merge edits or a clear outline for a human writer to refine. It augments your technical writing team by eliminating the tedious, mechanical parts of doc maintenance. | ||
|
|
||
| Fern Scribe understands Fern components like snippets, callouts, and tables, as well as your custom components and styling. It learns your writing style and makes edits that fit your existing navigation and content organization. You can further customize Fern Scribe's behavior to match your team's preferences, style guide, and workflow. | ||
| ## How Fern Scribe works |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'How Fern Scribe works' should use sentence-style capitalization.
Contributor
devin-ai-integration
bot
changed the title
- Replace prose with Steps component for 'How Scribe works' - Convert Connectors section to AccordionGroup for better UX - Simplify Mermaid diagram to vertical flow ending at PR - Fix Vale style issues (remove hyphen, sentence case heading) - Add Tip callout in Customization section Co-Authored-By: [email protected] <[email protected]>
| Scribe opens pull requests with either ready-to-merge edits or a clear outline for a human writer to refine. It augments your technical writing team by eliminating the tedious, mechanical parts of doc maintenance. | ||
|
|
||
| Fern Scribe understands Fern components like snippets, callouts, and tables, as well as your custom components and styling. It learns your writing style and makes edits that fit your existing navigation and content organization. You can further customize Fern Scribe's behavior to match your team's preferences, style guide, and workflow. | ||
| ## How Scribe works |
Contributor
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'How Scribe works' should use sentence-style capitalization.
devin-ai-integration
bot
changed the title
Contributor
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.
Enhance Scribe docs with Fern components and simplified architecture
Summary
Improved the Fern Scribe documentation by replacing prose with interactive Fern components and simplifying the architecture diagram based on user feedback. The page now uses Steps, AccordionGroup, and Tip components for better UX and scannability.
Key changes:
Review & Testing Checklist for Human
Test Plan
Notes