Skip to content

Commit 184e3d1

Browse files
committed
update
1 parent d63337d commit 184e3d1

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

fern/products/docs/pages/navigation/products.mdx

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ fern/
4949
├─ ...
5050
├─ product-a.yml # Contents and navigation for Product A
5151
└─ product-b.yml # Contents and navigation for Product B
52-
# No yml file needed for external products
52+
# No separate yml file needed for external products
5353
```
5454

5555
<CodeBlocks>
@@ -96,9 +96,9 @@ tabs:
9696
</Step>
9797
<Step title="Add your product configuration">
9898
99-
To define a product, add an item to the `products` list in `docs.yml`, specifying the `display-name` and `path`.
99+
To define a product, add an item to the `products` list in `docs.yml`, specifying the `display-name` and either `path` (for internal products) or `href` (for external products).
100100

101-
The optional parameters are: `image`, `icon`, `subtitle`, `slug`, and `versions`. If you provide both an `image` and an `icon`, the `image` will take precedence.
101+
For both internal and external products, `image`, `icon`, and `subtitle` are optional parameters. If you provide both an `image` and an `icon`, the `image` will take precedence. Internal products additionally support the optional `slug` and `versions` parameters.
102102

103103
<Note title="Product icons">
104104
<Markdown src="/snippets/icons.mdx" />
@@ -107,7 +107,7 @@ The optional parameters are: `image`, `icon`, `subtitle`, `slug`, and `versions`
107107
The below example is a `docs.yml` configuration for a site with two internal products (Product A and Product B) and one external product (Product C).
108108

109109
<CodeBlock title="docs.yml">
110-
```yaml {2-3, 8-9}
110+
```yaml {2-3, 8-9, 14-15}
111111
products:
112112
- display-name: Product A
113113
path: ./products/product-a.yml
@@ -128,19 +128,21 @@ products:
128128
```
129129
</CodeBlock>
130130

131-
External products (like Product C above) use `href` to link to external URLs and don't require a product-specific `.yml` file in the `products` folder. Optional parameters (`image`, `icon`, `subtitle`) are supported, but versions, tabs, and navigation are not.
132-
133-
134131
</Step>
135132
<Step title="Remove extra navigation from docs.yml">
136133

137134
If your `docs.yml` file includes a `navigation` field or a `tabs` field, be sure to remove. Those fields should now belong in the product-specific `.yml` files.
135+
136+
<Note>
137+
External products don't support `navigation` and `tabs` fields.
138+
</Note>
139+
138140
</Step>
139141
</Steps>
140142

141143
### Add versioning to your products
142144

143-
You can optionally add versions to your products. Versioned and unversioned products can live next to each other in your site.
145+
You can optionally add versions to your internal products. Versioned and unversioned products can live next to each other in your site. Versions are not supported for external products.
144146

145147
<Note>For standalone versioning without products, see our [Versioning guide](/docs/configuration/versions).</Note>
146148

0 commit comments

Comments
 (0)