-
Notifications
You must be signed in to change notification settings - Fork 4
Enhance Scribe docs with Fern components and simplified architecture #2054
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
Open
devin-ai-integration
wants to merge
3
commits into
main
Choose a base branch
from
devin/1763335788-improve-scribe-docs
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
6fa97f2
docs: improve Fern Scribe documentation with architecture and connectors
devin-ai-integration[bot] d7058c0
fix(cli-changelog): escape curly braces in inline text to unblock CI
devin-ai-integration[bot] 7fe6291
refactor: use more Fern components in Scribe docs
devin-ai-integration[bot] 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,74 @@ | ||
| --- | ||
| title: Fern Scribe | ||
| description: Fern Scribe is a technical writing agent that automatically updates documentation when your code and products change | ||
| description: Fern Scribe is a technical writing agent that automatically updates documentation when your code and products change. | ||
| --- | ||
|
|
||
| <Note> | ||
| Fern Scribe is not yet generally available. Interested in early access? Reach out via Slack or [email protected]. | ||
| </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. | ||
|
|
||
| It notices code changes and issue tracker updates (Linear, Jira) then drafts concise, targeted edits to your documentation pages via GitHub. You can ask Fern Scribe to iterate or edit directly yourself. | ||
| 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 | ||
|
|
||
| <Steps> | ||
| <Step title="Detect signals"> | ||
| Scribe monitors code changes, issue transitions, feature rollouts, and messaging threads across your engineering tools. | ||
| </Step> | ||
| <Step title="Determine impact"> | ||
| It maps changes to affected documentation pages and identifies the right locations to update. | ||
| </Step> | ||
| <Step title="Draft edits"> | ||
| It generates concise, targeted edits aligned with your writing style, understanding Fern components, custom MDX, and your design system. | ||
| </Step> | ||
| <Step title="Open pull request"> | ||
| It opens a PR in your repo for review, with either ready-to-merge edits or a clear outline for refinement. | ||
| </Step> | ||
| </Steps> | ||
|
|
||
| Scribe is fully compatible with [Vale](https://vale.sh), allowing teams to enforce style guides as part of the automated doc-update workflow. | ||
|
|
||
| ## Architecture | ||
|
|
||
| ```mermaid | ||
| flowchart TB | ||
| subgraph Signals | ||
| A[Code changes] | ||
| B[Issue updates] | ||
| C[Messaging] | ||
| D[Feature flags] | ||
| end | ||
| A --> S(Scribe) | ||
| B --> S | ||
| C --> S | ||
| D --> S | ||
| S --> PR[Pull request opened] | ||
| ``` | ||
|
|
||
| ## Connectors | ||
|
|
||
| Scribe uses connectors to gather the context it needs to write accurate, up-to-date documentation. These reflect the tools your engineering and product org already uses. | ||
|
|
||
| <AccordionGroup> | ||
| <Accordion title="Version control"> | ||
| GitHub and GitLab. Detects meaningful code changes such as new endpoints, schema updates, and feature flag usage. | ||
| </Accordion> | ||
| <Accordion title="Messaging"> | ||
| Slack and Microsoft Teams. Captures intent, internal announcements, and product context that doesn't always appear in code. | ||
| </Accordion> | ||
| <Accordion title="Issue tracking"> | ||
| Jira and Linear. Interprets issue transitions, milestones, and completed work to infer user-facing impact. | ||
| </Accordion> | ||
| <Accordion title="Feature flags"> | ||
| LaunchDarkly and Unleash. Enables documentation that reflects staged rollouts, beta features, and gradual feature exposure. | ||
| </Accordion> | ||
| </AccordionGroup> | ||
|
|
||
| ## Customization | ||
|
|
||
| You can tailor Scribe to match your style guides (including Vale rules), documentation structure and navigation, custom components, topics or areas Scribe should ignore, and your preferred review and publishing workflow. Scribe becomes a collaborative writing partner that writes in your team's voice and conventions. | ||
|
|
||
| <Tip>Use Vale locally and in CI to keep Scribe's drafts aligned with your style rules.</Tip> | ||
Oops, something went wrong.
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.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'How Scribe works' should use sentence-style capitalization.