Skip to content

Commit 0ac08ff

Browse files
authored
(docs) Document changelog tags (#1026)
1 parent 8a48fd1 commit 0ac08ff

File tree

3 files changed

+48
-20
lines changed

3 files changed

+48
-20
lines changed

fern/products/docs/pages/customization/frontmatter.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,4 +253,13 @@ Currently, relative paths are _not_ supported for this field.
253253
[Use the metadata field in the `docs.yml` file](/learn/docs/configuration/what-is-docs-yml#seo-metadata-configuration).
254254
</Note>
255255

256-
<Markdown src="/snippets/seo-metadata-page.mdx" />
256+
<Markdown src="/snippets/seo-metadata-page.mdx" />
257+
258+
## Changelog tags
259+
260+
<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.
262+
</ParamField>
263+
264+
<Markdown src="/snippets/changelog-example.mdx" />
265+

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

Lines changed: 15 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Keep a Changelog
33
subtitle: Record the notable changes to your project
44
---
55

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.
77

88
<Frame
99
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
107107

108108
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.
109109

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.
110+
<Markdown src="/snippets/changelog-example.mdx" />
115111

116-
### What's new?
112+
### Entry date
117113

118-
New endpoints:
114+
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:
119115

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)
121119

122-
New object schemas:
120+
### Tags
123121

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:
125123

126-
<Note> Have questions? Reach out to your local botanist. </Note>
124+
<CodeBlock>
125+
```mdx
126+
---
127+
tags: ["plants-api", "breaking-change", "inventory-management"]
128+
---
127129
```
128130
</CodeBlock>
129131

130-
### Entry date
131-
132-
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.
137133

138134
### Linking to an Entry
139135

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<CodeBlock title = "fern/openapi/changelog/2024-07-31.mdx">
2+
```mdx
3+
---
4+
tags: ["plants-api", "breaking-change", "inventory-management"]
5+
---
6+
7+
## Summary
8+
9+
In the latest release, we've added endpoints to create a new Plant.
10+
11+
### What's new?
12+
13+
New endpoints:
14+
15+
- `POST /plant` add a new plant to inventory.
16+
17+
New object schemas:
18+
19+
- `CreatePlantRequest`
20+
21+
<Note> Have questions? Reach out to your local botanist. </Note>
22+
```
23+
</CodeBlock>

0 commit comments

Comments
 (0)