Add Fern Writer capabilities and customization documentation#3853
Add Fern Writer capabilities and customization documentation#3853devin-ai-integration[bot] wants to merge 2 commits intomainfrom
Conversation
🤖 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:
|
|
Requested by: kenny |
| Ask Fern Writer to review your docs for issues that are hard to catch manually across many pages. | ||
|
|
||
| - **Check for inconsistencies** in terminology, formatting, or tone across pages | ||
| - **Apply style changes broadly**, such as renaming a product or updating terminology site-wide |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Adverbs] Remove 'broadly' if it's not important to the meaning of the statement.
|
|
||
| Fern Writer responds to feedback from both humans and automated review tools such as linters or CI checks. It continues iterating until the PR meets your requirements. | ||
|
|
||
| ## Customization with AGENTS.md |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Customization with AGENTS.md' should use sentence-style capitalization.
| - **Structural conventions** — how pages are organized, required sections, heading hierarchy | ||
| - **Component preferences** — when to use specific Fern components like Callouts vs. Asides | ||
| - **Terminology rules** — product names, feature names, and terms that must be used consistently | ||
| - **Files or directories to avoid** — content that Fern Writer should not modify |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.
|
🌿 Preview your docs: https://fern-preview-a59fcd90-b5d4-4d40-b7ef-67317a7c288d.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
|
|
||
| Fern Writer responds to feedback from both humans and automated review tools such as linters or CI checks. It continues iterating until the PR meets your requirements. | ||
|
|
||
| ## Customize with AGENTS.md |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'Customize with AGENTS.md' should use sentence-style capitalization.
Add Fern Writer capabilities and AGENTS.md customization docs
Summary
Expands the Fern Writer documentation page (
fern/products/docs/pages/ai/writer.mdx) with two new sections inserted between the existing "How it works" and "Setup" sections:Capabilities — A structured breakdown of what Fern Writer can do, organized into six subsections:
Customize with AGENTS.md — Documents how teams can customize Fern Writer behavior via a repository-level
AGENTS.mdfile (style, conventions, terminology, component preferences, exclusions).No existing content was modified — this is purely additive.
Updates since last revision
Review & Testing Checklist for Human
docs.ymlnavigation config, adding redirects, processing GitHub issues). These were sourced from blog posts and existing docs references — confirm they reflect actual product behavior.AGENTS.mdcan control (component preferences, files to avoid, etc.). Confirm these are actually supported./learn/docs/writing-content/components/overview,/learn/docs/writing-content/components/callouts,/learn/docs/writing-content/components/cards,/learn/docs/writing-content/components/code-blocks,/learn/docs/writing-content/components/steps,/learn/docs/writing-content/components/tabs, and/learn/docs/writing-content/components/accordions. Verify all resolve correctly.Suggested test plan: Open the preview link and read through the full page. Verify the new Capabilities and Customize sections flow naturally between "How it works" and "Setup." Click each internal link to confirm they resolve. Cross-check capability claims against known Fern Writer behavior.
Notes
writer.mdxpage itself.docs.yml) were needed since the page already exists.Requested by: Fern Support
Link to Devin run