Skip to content

Add Fern Writer capabilities and customization documentation#3853

Open
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
fern/add-fern-writer-capabilities
Open

Add Fern Writer capabilities and customization documentation#3853
devin-ai-integration[bot] wants to merge 2 commits intomainfrom
fern/add-fern-writer-capabilities

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Feb 26, 2026

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:

  1. Capabilities — A structured breakdown of what Fern Writer can do, organized into six subsections:

    • Write and update content (new pages, sections, fixes)
    • Use Fern components (component library awareness)
    • Reorganize and restructure (navigation, redirects, page merging)
    • Review and improve quality (consistency checks, style changes)
    • Work from external context (GitHub PRs/issues, Slack threads, attachments)
    • Iterate on feedback (Slack thread + PR comment loop)
  2. Customize with AGENTS.md — Documents how teams can customize Fern Writer behavior via a repository-level AGENTS.md file (style, conventions, terminology, component preferences, exclusions).

No existing content was modified — this is purely additive.

Updates since last revision

  • Fixed three Vale lint issues flagged by reviewdog:
    • Replaced adverb "broadly" with "across pages"
    • Changed heading from "Customization with AGENTS.md" to "Customize with AGENTS.md" (sentence-style capitalization)
    • Used contraction "shouldn't" instead of "should not"

Review & Testing Checklist for Human

  • Verify capability claims are accurate: Each subsection makes specific promises about what Fern Writer can do (e.g., updating docs.yml navigation config, adding redirects, processing GitHub issues). These were sourced from blog posts and existing docs references — confirm they reflect actual product behavior.
  • Verify AGENTS.md customization claims: The section lists specific things AGENTS.md can control (component preferences, files to avoid, etc.). Confirm these are actually supported.
  • Check internal links: The "Use Fern components" subsection links to /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.
  • Review rendered output: Preview deployment is available at the link below — check that the new sections render correctly and read well in context with the existing content.

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

  • The content was sourced from existing references across the docs repo, the Fern blog post on AI agents for technical writing, and the existing writer.mdx page itself.
  • No changes to navigation config (docs.yml) were needed since the page already exists.

Requested by: Fern Support
Link to Devin run

@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@fern-api
Copy link
Contributor

fern-api bot commented Feb 26, 2026

Requested by: kenny
Slack thread: View conversation

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
Copy link
Contributor

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.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
Copy link
Contributor

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] '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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'shouldn't' instead of 'should not'.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 26, 2026

🌿 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
Copy link
Contributor

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] 'Customize with AGENTS.md' should use sentence-style capitalization.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants