You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/products.mdx
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -49,7 +49,7 @@ fern/
49
49
├─ ...
50
50
├─ product-a.yml # Contents and navigation for Product A
51
51
└─ 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
53
53
```
54
54
55
55
<CodeBlocks>
@@ -96,9 +96,9 @@ tabs:
96
96
</Step>
97
97
<Step title="Add your product configuration">
98
98
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).
100
100
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.
102
102
103
103
<Note title="Product icons">
104
104
<Markdown src="/snippets/icons.mdx" />
@@ -107,7 +107,7 @@ The optional parameters are: `image`, `icon`, `subtitle`, `slug`, and `versions`
107
107
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).
108
108
109
109
<CodeBlock title="docs.yml">
110
-
```yaml {2-3, 8-9}
110
+
```yaml {2-3, 8-9, 14-15}
111
111
products:
112
112
- display-name: Product A
113
113
path: ./products/product-a.yml
@@ -128,19 +128,21 @@ products:
128
128
```
129
129
</CodeBlock>
130
130
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
-
134
131
</Step>
135
132
<Step title="Remove extra navigation from docs.yml">
136
133
137
134
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
+
138
140
</Step>
139
141
</Steps>
140
142
141
143
### Add versioning to your products
142
144
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.
144
146
145
147
<Note>For standalone versioning without products, see our [Versioning guide](/docs/configuration/versions).</Note>
0 commit comments