Skip to content

Commit fe21530

Browse files
committed
start adding update component stuff
1 parent 4e00526 commit fe21530

File tree

2 files changed

+6
-1
lines changed

2 files changed

+6
-1
lines changed

components/update.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,11 @@ The `Update` component is used to keep track of changes and updates.
5858
</ResponseField>
5959

6060

61+
<ResponseField name="rss" type="object: { title: string; description: string; }">
62+
Title and description how you would like for them to appear in generated RSS feeds for this update. Learn more about [subscribable changelogs](/guides/changelogs).
63+
</ResponseField>
64+
65+
6166
<RequestExample>
6267

6368
```mdx Update Example

guides/changelogs.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Using the Update component on your changelog page also automatically creates a s
3535

3636
After publishing a new Update on the page, it will be automatically included in the RSS feed for that page. RSS feeds can be integrated with Slack, email, or other subscription tools for your users.
3737

38-
You can customize the text included for each Update item with the feedTitle and feedUpdate properties:
38+
You can customize the text included for each Update item with the rss property:
3939

4040
```mdx
4141
<Update label="v0.0.10" rss={title: "Version 0.0.10 is now live", description: "Including updates to AI models and more"} feedDescription=>

0 commit comments

Comments
 (0)