Skip to content

Add feedTitle and feedDescription to Update component page #819

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add feedTitle and feedDescription to Update component page #819

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 11 additions & 2 deletions components/update.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
</Update>

<Tip>
Each `label` creates an anchor and also shows up on the table of contents on the right.
Each `label` creates an anchor link used to generate the table of contents on the page and to link to updates in [subscribable changelogs](/).

Check warning on line 43 in components/update.mdx

View check run for this annotation

Mintlify / Mintlify Validation - vale-spellcheck

components/update.mdx#L43 

Did you really mean 'subscribable'?
</Tip>

## Props
Expand All @@ -57,11 +57,20 @@
Description of the update, appears below the label and tag.
</ResponseField>

<ResponseField name="feedTitle" type="string">
Title of the update how you would like for it to appear in the RSS feed
</ResponseField>

<ResponseField name="feedDescription" type="string">
Description of the update how you would like for it to appear in the RSS feed
</ResponseField>


<RequestExample>

```mdx Update Example
<Update label="2024-10-12" description="v0.1.1">
<Update label="2024-10-12" description="v0.1.1" feedTitle="Example Update for October 10"
feedDescription="This is how you use a changelog with a label and a description.">
This is how you use a changelog with a label
and a description.
</Update>
Expand Down