Skip to content

Warn against Markdown links in Download component children #6944

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

Open
fern-api wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Warn against Markdown links in Download component children #6944

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
2 changes: 1 addition & 1 deletion fern/products/docs/pages/component-library/default-components/download.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ This is useful when you want users to download a collection of related assets
</ParamField>

<ParamField path="children" type="React.ReactNode" required={true}>
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`.
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. Do not wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.

@github-actions github-actions Bot Sep 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ [vale] <Microsoft.UIVerbs> reported by reviewdog 🐶
Use 'select' instead of the input-specific verb 'click'.

@github-actions github-actions Bot Sep 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'don't' instead of 'Do not'.

Suggested change
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. Do not wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.
The text or element to display as the click target for the download. Can be plain text (e.g. `Download PDF`) or a React element such as a `<Button>`. don't wrap the text in a Markdown link (e.g. `[Download PDF](./file.pdf)`) — `<Download>` handles the link behavior itself, so a Markdown link is both incorrect and unnecessary.

</ParamField>

<ParamField path="filename" type="string">
Expand Down
Loading