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
<ParamField path="tags" type="array of strings" required={false}>
261
+
For [changelog pages](/docs/customization/changelogs) only. Tags allow users to filter changelog entries by specific categories. Define tags as an array of strings in the frontmatter.
Copy file name to clipboardExpand all lines: fern/products/docs/pages/navigation/changelogs.mdx
+15-19Lines changed: 15 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Keep a Changelog
3
3
subtitle: Record the notable changes to your project
4
4
---
5
5
6
-
Keep a record of how your project has changed by writing changelog entries. The changelog will automatically populate with the files contained within the `changelog` folder.
6
+
Keep a record of how your project has changed by writing changelog entries that users can sort by tag. The changelog will automatically populate with the files contained within the `changelog` folder.
7
7
8
8
<Frame
9
9
caption="Keep your users updated as your project evolves"
@@ -107,33 +107,29 @@ If an `overview.mdx` file is present, it will appear above the list of changelog
107
107
108
108
Create a new changelog entry by writing a Markdown file. You can use `.md` or `.mdx` files. The benefit of using `.mdx` is that you can leverage the built-in [component library](/learn/docs/content/components/overview) within an entry.
109
109
110
-
<CodeBlock title = "fern/openapi/changelog/2024-07-31.mdx">
111
-
```mdx
112
-
## Summary
113
-
114
-
In the latest release, we've added endpoints to create a new Plant.
Changelog entries are automatically sorted chronologically by the date specific in the file name. Specify the date of your entry using one of the following formats:
119
115
120
-
- `POST /plant` add a new plant to inventory.
116
+
- MM-DD-YYYY (e.g., 10-06-2024)
117
+
- MM-DD-YY (e.g., 10-06-24)
118
+
- YYYY-MM-DD (e.g., 2024-04-21)
121
119
122
-
New object schemas:
120
+
### Tags
123
121
124
-
- `CreatePlantRequest`
122
+
Add tags to changelog entries to help users filter and find relevant updates. Tags are defined in the frontmatter of your changelog entry as an array of strings:
125
123
126
-
<Note> Have questions? Reach out to your local botanist. </Note>
Changelog entries are automatically sorted chronologically by the date specific in the file name. Specify the date of your entry using one of the following formats:
133
-
134
-
- MM-DD-YYYY (e.g., 10-06-2024)
135
-
- MM-DD-YY (e.g., 10-06-24)
136
-
- YYYY-MM-DD (e.g., 2024-04-21)
132
+
When you have multiple changelog entries, users can filter the changelog page by selecting specific tags. Use specific, descriptive tags that your users would naturally search for. Consider tagging by feature type, product area, release stage, affected platform, or user impact.
0 commit comments