Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion fern/products/docs/pages/customization/frontmatter.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -253,4 +253,15 @@ Currently, relative paths are _not_ supported for this field.
[Use the metadata field in the `docs.yml` file](/learn/docs/configuration/what-is-docs-yml#seo-metadata-configuration).
</Note>

<Markdown src="/snippets/seo-metadata-page.mdx" />
<Markdown src="/snippets/seo-metadata-page.mdx" />

## Changelog tags

<ParamField path="tags" type="array of strings" required={false}>
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.

For non-changelog pages, [use `keywords`](/docs/configuration/page-level-settings#document-properties).
</ParamField>

<Markdown src="/snippets/changelog-example.mdx" />

34 changes: 15 additions & 19 deletions fern/products/docs/pages/navigation/changelogs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Keep a Changelog
subtitle: Record the notable changes to your project
---

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

<Frame
caption="Keep your users updated as your project evolves"
Expand Down Expand Up @@ -107,33 +107,29 @@ If an `overview.mdx` file is present, it will appear above the list of changelog

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.

<CodeBlock title = "fern/openapi/changelog/2024-07-31.mdx">
```mdx
## Summary

In the latest release, we've added endpoints to create a new Plant.
<Markdown src="/snippets/changelog-example.mdx" />

### What's new?
### Entry date

New endpoints:
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:

- `POST /plant` add a new plant to inventory.
- MM-DD-YYYY (e.g., 10-06-2024)
- MM-DD-YY (e.g., 10-06-24)
- YYYY-MM-DD (e.g., 2024-04-21)

New object schemas:
### Tags

- `CreatePlantRequest`
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:

<Note> Have questions? Reach out to your local botanist. </Note>
<CodeBlock>
```mdx
---
tags: ["plants-api", "breaking-change", "inventory-management"]
---
```
</CodeBlock>

### Entry date

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:

- MM-DD-YYYY (e.g., 10-06-2024)
- MM-DD-YY (e.g., 10-06-24)
- YYYY-MM-DD (e.g., 2024-04-21)
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.

### Linking to an Entry

Expand Down
23 changes: 23 additions & 0 deletions fern/snippets/changelog-example.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
<CodeBlock title = "fern/openapi/changelog/2024-07-31.mdx">
```mdx
---
tags: ["plants-api", "breaking-change", "inventory-management"]
---

## Summary

In the latest release, we've added endpoints to create a new Plant.

### What's new?

New endpoints:

- `POST /plant` add a new plant to inventory.

New object schemas:

- `CreatePlantRequest`

<Note> Have questions? Reach out to your local botanist. </Note>
```
</CodeBlock>