chore(kno-11556): Update Step component to add h4 support and heading size alignment#1307
chore(kno-11556): Update Step component to add h4 support and heading size alignment#1307
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
Bugbot Autofix is OFF. To automatically fix reported issues with Cloud Agents, enable Autofix in the Cursor dashboard.
| > | ||
| {title} | ||
| </Heading> | ||
| ); |
There was a problem hiding this comment.
Duplicated code between h2 case and default case
Low Severity
The h2 case and default case in TitleTag now have identical implementations - both render a Heading with as="h2" and size="4" with the same props. This duplication increases maintenance burden and risks inconsistent bug fixes if someone updates one case but forgets to update the other. The cases could be combined using a fallthrough pattern.
Additional Locations (1)
|
|
||
| <Steps titleSize="h4"> | ||
| <Step title="Get the `access_token` stored in Knock for the user's tenant"> | ||
| <Step title="Get the access_token stored in Knock for the user's tenant"> |
There was a problem hiding this comment.
Didn't see this in the PR description so just making sure you intend to include this?
2 participants
Description
I noticed that step headings weren't appearing in this section of the docs, and after digging in realized that this was because the
titleSizewas set toh4and theStepcomponent was returningnullin this case. To have better support moving forward, I've added the following changes:titleSize="h4"(previously there was only support for"p","h2"and"h3"Headingsize asSectionHeading(used for ##, ###, #### in MDX via mdxComponents) to help keep the step headings consistent with the rest of the docs.Tasks
KNO-11556
Screenshots
Before:
After:
Cursor Bugbot found 1 potential issue for commit 48a6f48