diff --git a/README.md b/README.md index fe50428..93a143f 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,7 @@ Example Fern docs projects. Each top-level folder is a self-contained example wi | --- | --- | --- | | [`docs-starter`](./docs-starter) | Minimal starter project | [docs-starter.docs.buildwithfern.com](https://docs-starter.docs.buildwithfern.com) | | [`i18n`](./i18n) | Multi-language docs with English + Japanese translations | [i18n.docs.buildwithfern.com](https://i18n.docs.buildwithfern.com) | +| [`multi-source`](./multi-source) | Multiple teams publishing to one domain from separate repos | [multi-source.docs.buildwithfern.com](https://multi-source.docs.buildwithfern.com) | | [`versioning`](./docs-versioned) | Versioned site with a version dropdown and a shared page | [versioning.docs.buildwithfern.com](https://versioning.docs.buildwithfern.com) | ## Use an example diff --git a/multi-source/README.md b/multi-source/README.md new file mode 100644 index 0000000..6034589 --- /dev/null +++ b/multi-source/README.md @@ -0,0 +1,38 @@ +# Multi-source docs + +This example shows how multiple teams can publish to the same custom domain from independent repositories using Fern's [multi-source docs](https://buildwithfern.com/learn/docs/preview-publish/multi-source-docs) feature. + +## Structure + +In production, each folder would be its own repository. They are grouped here for demonstration: + +``` +multi-source/ +├── homepage/ # Root of the domain — landing page with cards linking to each team +├── seeds/ # /seeds sub-path — seed catalog and planting guides +├── greenhouses/ # /greenhouses sub-path — climate control and monitoring +└── nursery/ # /nursery sub-path — plant care and propagation +``` + +Each folder contains a standalone `fern/` project with its own `docs.yml` and content. All four projects: + +- Target the same base domain (`multi-source.docs.buildwithfern.com`) +- Set `multi-source: true` on their instance +- Share the same colors and logo (in production, use a [global theme](https://buildwithfern.com/learn/docs/customization/global-themes) instead of duplicating branding) + +## Publishing + +Each project publishes independently: + +```bash +cd homepage && fern generate --docs +cd seeds && fern generate --docs +cd greenhouses && fern generate --docs +cd nursery && fern generate --docs +``` + +Updating one sub-path has no effect on the others. + +## Learn more + +See the [multi-source docs guide](https://buildwithfern.com/learn/docs/preview-publish/multi-source-docs) for the full setup instructions, including global themes and Dashboard configuration. diff --git a/multi-source/greenhouses/fern/assets/logo-dark.svg b/multi-source/greenhouses/fern/assets/logo-dark.svg new file mode 100644 index 0000000..144e0e3 --- /dev/null +++ b/multi-source/greenhouses/fern/assets/logo-dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/multi-source/greenhouses/fern/assets/logo-light.svg b/multi-source/greenhouses/fern/assets/logo-light.svg new file mode 100644 index 0000000..2d280fe --- /dev/null +++ b/multi-source/greenhouses/fern/assets/logo-light.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/multi-source/greenhouses/fern/docs.yml b/multi-source/greenhouses/fern/docs.yml new file mode 100644 index 0000000..3bfc972 --- /dev/null +++ b/multi-source/greenhouses/fern/docs.yml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json + +instances: + - url: multi-source.docs.buildwithfern.com/greenhouses + multi-source: true + +title: Greenhouses + +colors: + accent-primary: + dark: "#70E155" + light: "#008700" + background: + dark: "#111113" + light: "#FFFFFF" + +logo: + dark: ./assets/logo-dark.svg + light: ./assets/logo-light.svg + height: 20 + +navigation: + - section: Getting started + contents: + - page: Overview + path: ./pages/overview.mdx + - page: Climate controls + path: ./pages/climate-controls.mdx diff --git a/multi-source/greenhouses/fern/fern.config.json b/multi-source/greenhouses/fern/fern.config.json new file mode 100644 index 0000000..1e88757 --- /dev/null +++ b/multi-source/greenhouses/fern/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization": "fern-docs-examples", + "version": "5.2.0" +} diff --git a/multi-source/greenhouses/fern/pages/climate-controls.mdx b/multi-source/greenhouses/fern/pages/climate-controls.mdx new file mode 100644 index 0000000..06447ff --- /dev/null +++ b/multi-source/greenhouses/fern/pages/climate-controls.mdx @@ -0,0 +1,20 @@ +--- +title: Climate controls +subtitle: Configure temperature, humidity, and lighting +--- + +Climate controls let you define target ranges for each environmental variable and set up automated responses when readings fall outside those ranges. + +## Temperature zones + + + +Group your greenhouse into zones based on the types of plants in each area. Tropical plants need 75-85°F, while temperate species prefer 60-70°F. + + +Configure minimum and maximum temperatures for each zone. The system triggers alerts and activates heating or cooling when readings cross these boundaries. + + +Check historical temperature data to identify patterns and optimize your zone configuration over time. + + diff --git a/multi-source/greenhouses/fern/pages/overview.mdx b/multi-source/greenhouses/fern/pages/overview.mdx new file mode 100644 index 0000000..635ebe5 --- /dev/null +++ b/multi-source/greenhouses/fern/pages/overview.mdx @@ -0,0 +1,13 @@ +--- +title: Greenhouses overview +subtitle: Monitor and automate your greenhouse environment +--- + +The Greenhouses API provides tools for monitoring temperature, humidity, and lighting across your greenhouse facilities. + +## Features + +- Real-time temperature and humidity monitoring +- Automated irrigation scheduling +- Light cycle management for different plant stages +- Alert configuration for environmental thresholds diff --git a/multi-source/homepage/fern/assets/logo-dark.svg b/multi-source/homepage/fern/assets/logo-dark.svg new file mode 100644 index 0000000..144e0e3 --- /dev/null +++ b/multi-source/homepage/fern/assets/logo-dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/multi-source/homepage/fern/assets/logo-light.svg b/multi-source/homepage/fern/assets/logo-light.svg new file mode 100644 index 0000000..2d280fe --- /dev/null +++ b/multi-source/homepage/fern/assets/logo-light.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/multi-source/homepage/fern/docs.yml b/multi-source/homepage/fern/docs.yml new file mode 100644 index 0000000..04e3e05 --- /dev/null +++ b/multi-source/homepage/fern/docs.yml @@ -0,0 +1,24 @@ +# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json + +instances: + - url: multi-source.docs.buildwithfern.com + multi-source: true + +title: Plant Store Docs + +colors: + accent-primary: + dark: "#70E155" + light: "#008700" + background: + dark: "#111113" + light: "#FFFFFF" + +logo: + dark: ./assets/logo-dark.svg + light: ./assets/logo-light.svg + height: 20 + +navigation: + - page: Home + path: ./pages/home.mdx diff --git a/multi-source/homepage/fern/fern.config.json b/multi-source/homepage/fern/fern.config.json new file mode 100644 index 0000000..1e88757 --- /dev/null +++ b/multi-source/homepage/fern/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization": "fern-docs-examples", + "version": "5.2.0" +} diff --git a/multi-source/homepage/fern/pages/home.mdx b/multi-source/homepage/fern/pages/home.mdx new file mode 100644 index 0000000..ee37c9b --- /dev/null +++ b/multi-source/homepage/fern/pages/home.mdx @@ -0,0 +1,31 @@ +--- +title: Plant Store documentation +subtitle: Everything you need to grow, manage, and sell plants +slug: welcome +--- + +Welcome to the Plant Store documentation hub. Each team maintains their own docs under a dedicated sub-path. Choose a product area below to get started. + + + + Seed catalog, germination guides, and planting schedules. + + + Climate control, monitoring, and automation. + + + Plant care, propagation, and inventory management. + + diff --git a/multi-source/nursery/fern/assets/logo-dark.svg b/multi-source/nursery/fern/assets/logo-dark.svg new file mode 100644 index 0000000..144e0e3 --- /dev/null +++ b/multi-source/nursery/fern/assets/logo-dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/multi-source/nursery/fern/assets/logo-light.svg b/multi-source/nursery/fern/assets/logo-light.svg new file mode 100644 index 0000000..2d280fe --- /dev/null +++ b/multi-source/nursery/fern/assets/logo-light.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/multi-source/nursery/fern/docs.yml b/multi-source/nursery/fern/docs.yml new file mode 100644 index 0000000..38caf8f --- /dev/null +++ b/multi-source/nursery/fern/docs.yml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json + +instances: + - url: multi-source.docs.buildwithfern.com/nursery + multi-source: true + +title: Nursery + +colors: + accent-primary: + dark: "#70E155" + light: "#008700" + background: + dark: "#111113" + light: "#FFFFFF" + +logo: + dark: ./assets/logo-dark.svg + light: ./assets/logo-light.svg + height: 20 + +navigation: + - section: Getting started + contents: + - page: Overview + path: ./pages/overview.mdx + - page: Plant care + path: ./pages/plant-care.mdx diff --git a/multi-source/nursery/fern/fern.config.json b/multi-source/nursery/fern/fern.config.json new file mode 100644 index 0000000..1e88757 --- /dev/null +++ b/multi-source/nursery/fern/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization": "fern-docs-examples", + "version": "5.2.0" +} diff --git a/multi-source/nursery/fern/pages/overview.mdx b/multi-source/nursery/fern/pages/overview.mdx new file mode 100644 index 0000000..3bcaa64 --- /dev/null +++ b/multi-source/nursery/fern/pages/overview.mdx @@ -0,0 +1,13 @@ +--- +title: Nursery overview +subtitle: Manage plant care and propagation +--- + +The Nursery API helps you track plant inventory, schedule care routines, and manage propagation workflows. + +## Features + +- Track individual plants through their lifecycle from cutting to sale +- Schedule watering, fertilizing, and pruning routines +- Manage propagation batches with success rate tracking +- Generate inventory reports by species, size, and availability diff --git a/multi-source/nursery/fern/pages/plant-care.mdx b/multi-source/nursery/fern/pages/plant-care.mdx new file mode 100644 index 0000000..bbbdced --- /dev/null +++ b/multi-source/nursery/fern/pages/plant-care.mdx @@ -0,0 +1,20 @@ +--- +title: Plant care +subtitle: Watering, fertilizing, and pruning schedules +--- + +Set up care routines for each plant species in your nursery. The system sends reminders and tracks completion. + +## Care schedule types + + + +Configure watering frequency based on species, pot size, and season. The system adjusts recommendations based on recent weather data. + + +Set fertilizer type and application intervals. Different growth stages require different nutrient balances. + + +Schedule pruning windows based on species-specific growth patterns and flowering cycles. + + diff --git a/multi-source/seeds/fern/assets/logo-dark.svg b/multi-source/seeds/fern/assets/logo-dark.svg new file mode 100644 index 0000000..144e0e3 --- /dev/null +++ b/multi-source/seeds/fern/assets/logo-dark.svg @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/multi-source/seeds/fern/assets/logo-light.svg b/multi-source/seeds/fern/assets/logo-light.svg new file mode 100644 index 0000000..2d280fe --- /dev/null +++ b/multi-source/seeds/fern/assets/logo-light.svg @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/multi-source/seeds/fern/docs.yml b/multi-source/seeds/fern/docs.yml new file mode 100644 index 0000000..8fd8bf3 --- /dev/null +++ b/multi-source/seeds/fern/docs.yml @@ -0,0 +1,28 @@ +# yaml-language-server: $schema=https://schema.buildwithfern.dev/docs-yml.json + +instances: + - url: multi-source.docs.buildwithfern.com/seeds + multi-source: true + +title: Seeds + +colors: + accent-primary: + dark: "#70E155" + light: "#008700" + background: + dark: "#111113" + light: "#FFFFFF" + +logo: + dark: ./assets/logo-dark.svg + light: ./assets/logo-light.svg + height: 20 + +navigation: + - section: Getting started + contents: + - page: Overview + path: ./pages/overview.mdx + - page: Seed catalog + path: ./pages/seed-catalog.mdx diff --git a/multi-source/seeds/fern/fern.config.json b/multi-source/seeds/fern/fern.config.json new file mode 100644 index 0000000..1e88757 --- /dev/null +++ b/multi-source/seeds/fern/fern.config.json @@ -0,0 +1,4 @@ +{ + "organization": "fern-docs-examples", + "version": "5.2.0" +} diff --git a/multi-source/seeds/fern/pages/overview.mdx b/multi-source/seeds/fern/pages/overview.mdx new file mode 100644 index 0000000..6fda0e3 --- /dev/null +++ b/multi-source/seeds/fern/pages/overview.mdx @@ -0,0 +1,13 @@ +--- +title: Seeds overview +subtitle: Browse and manage the seed catalog +--- + +The Seeds API lets you browse plant varieties, check availability, and manage planting schedules. + +## Features + +- Browse the full seed catalog with filtering by climate zone, season, and plant type +- Check real-time inventory and availability +- Create and manage planting schedules +- Track germination rates and growth progress diff --git a/multi-source/seeds/fern/pages/seed-catalog.mdx b/multi-source/seeds/fern/pages/seed-catalog.mdx new file mode 100644 index 0000000..c6107a5 --- /dev/null +++ b/multi-source/seeds/fern/pages/seed-catalog.mdx @@ -0,0 +1,20 @@ +--- +title: Seed catalog +subtitle: Search and filter available seeds +--- + +Use the seed catalog to find the right plants for your climate and growing season. + +## Search by category + + + +Annual and perennial vegetable seeds, sorted by growing season and hardiness zone. + + +Ornamental flower seeds for beds, borders, and containers. + + +Culinary and medicinal herb seeds for indoor and outdoor growing. + +