Skip to content

docs: migrate to Fern#1

Merged
hawkeyexl merged 8 commits intomainfrom
docs-migration-fern
Jan 30, 2026
Merged

docs: migrate to Fern#1
hawkeyexl merged 8 commits intomainfrom
docs-migration-fern

Conversation

@hawkeyexl
Copy link
Contributor

@hawkeyexl hawkeyexl commented Jan 27, 2026

Summary

Migrated documentation from Docusaurus to Fern, including cleaning up legacy components and creating a new landing page.

  • Removed temporary JSONSchemaViewer component and unused imports from action docs.
  • Removed auto-generated schema reference files (filetypes-*.md).
  • Converted Docusaurus admonitions (:::note) to Fern components (<Note>).
  • Implemented new Landing Page (fern/pages/index.mdx) with Hero and Features sections.

Test Plan

  • Verified removal of JSONSchemaViewer via grep.
  • Verified valid MDX syntax for modified files.
  • Verified fern docs dev builds successfully (with placeholder assets).

Summary by CodeRabbit

  • Documentation

    • Redesigned homepage with richer hero, features, and Get Started flows.
    • Removed embedded schema viewer sections from many action pages and deleted a couple of low-level schema reference pages.
    • Updated site footer repository link.
    • Bumped documented Node.js prerequisite to v20 in several contribution and tutorial pages.
  • Style

    • Standardized admonition components (Note/Tip/Info/Warning/Danger) in contribution and template content.
  • Chores

    • Simplified test script invocation in project metadata.

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 27, 2026 21:30
@coderabbitai
Copy link

coderabbitai bot commented Jan 27, 2026

Walkthrough

Convert fenced admonitions to MDX component tags, remove JSONSchemaViewer imports/sections from many action docs, redesign the homepage and front matter, delete two generated schema reference pages, update footer GitHub link and test script, and bump documented Node.js requirements in contributor guides.

Changes

Cohort / File(s) Summary
Admonition Syntax Conversion
fern/pages/contribute/standard-contributions.mdx, fern/pages/contribute/templates/feature.mdx
Replaced fenced directives (:::note, :::info, :::tip, :::warning, :::danger) with MDX component tags (<Note>, <Info>, <Tip>, <Warning>, <Danger>). Verify tab rendering and preserved content inside converted admonitions.
Schema Viewer Removal from Actions
fern/pages/docs/actions/{checkLink,click,dragAndDrop,find,goTo,httpRequest,loadCookie,loadVariables,record,runCode,runShell,saveCookie,screenshot,stopRecord,type,wait}.mdx
Removed import { schemas } ... and import JSONSchemaViewer ... plus the "Schema reference" sections and embedded <JSONSchemaViewer /> usages. Check for leftover schemas/JSONSchemaViewer references and links.
Homepage Redesign
fern/pages/index.mdx
Replaced front matter (explicit layout: overview, updated subtitle/description) and expanded body from placeholder to a full MDX landing page with hero, CTAs, feature/workflow sections, card groups, and commented assets. Review front-matter fields and content structure.
Schema Documentation Deletion
fern/pages/reference/schemas/...waituntil-2e1bb8d9.md, fern/pages/reference/schemas/...waituntil-find-10f35ec9.md
Deleted two generated schema reference pages describing waitUntil options and waitUntil-find schema. Ensure no site links or navigation reference the removed pages.
Prerequisites / Local Dev Updates
fern/pages/contribute/local-development.mdx, fern/pages/contribute/templates/tutorial.mdx, fern/pages/contribute/testing.mdx
Updated documented Node.js requirement from v18 to v20 in local development, tutorial prerequisites, and CI debugging docs. Confirm consistency across docs.
Config & Metadata Updates
docs.yml, package.json
Updated footer GitHub link to https://github.com/doc-detective in docs.yml; changed scripts.test in package.json from npx doc-detective@latest runTests to npx doc-detective. Verify CI/test invocation expectations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐇 I nibble tags and swap them neat,

Notes now nest where fences meet,
The homepage wakes in brighter light,
Two schema pages hop out of sight,
A tiny rabbit cheers — docs polished and tight.


Note

🎁 Summarized by CodeRabbit Free

Your organization is on the Free plan. CodeRabbit will generate a high-level summary and a walkthrough for each pull request. For a comprehensive line-by-line review, please upgrade your subscription to CodeRabbit Pro by visiting https://app.coderabbit.ai/login.

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR migrates the documentation from Docusaurus to Fern, a modern documentation framework. The migration includes cleanup of legacy components, conversion of syntax elements to Fern-compatible formats, and creation of a new landing page.

Changes:

  • Removed JSONSchemaViewer component and imports from 16 action documentation files
  • Deleted 2 auto-generated schema reference files that are no longer needed
  • Converted all Docusaurus admonitions (:::note, :::tip, etc.) to Fern components (, , )
  • Created a new landing page with hero image, features section, and code examples

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
fern/pages/index.mdx New landing page with hero section, feature cards, and sample code
fern/assets/images/landing/hero.png New hero image for landing page
fern/pages/reference/schemas/filetypes-anyof-0--array-anyof-1--markup-array-actions-anyof-1--array-anyof-1--anyof-3--allof-1--goto-anyof-1--waituntil-find-10f35ec9.md Removed auto-generated schema reference file
fern/pages/reference/schemas/filetypes-anyof-0--array-anyof-1--markup-array-actions-anyof-1--array-anyof-1--anyof-3--allof-1--goto-anyof-1--waituntil-2e1bb8d9.md Removed auto-generated schema reference file
fern/pages/docs/actions/*.mdx (16 files) Removed JSONSchemaViewer component and related imports
fern/pages/contribute/templates/feature.mdx Converted Docusaurus admonition to Fern Note component
fern/pages/contribute/standard-contributions.mdx Converted all Docusaurus admonitions to Fern components (Note, Tip, Warning)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

- Change GitHub link in footer to point to the correct repository.
- Revise content on the index page for clarity and engagement.
- Add buttons for user actions and enhance documentation structure.
- Introduce new sections to improve user guidance and experience.
@hawkeyexl hawkeyexl merged commit 4035b0b into main Jan 30, 2026
1 of 2 checks passed
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.

2 participants