chore(kno-11556): Update Step component to add h4 support and heading size alignment#1307
Open
rachael-t wants to merge 5 commits into
Open
chore(kno-11556): Update Step component to add h4 support and heading size alignment#1307rachael-t wants to merge 5 commits into
rachael-t wants to merge 5 commits into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
scotidodson
approved these changes
Feb 20, 2026
|
|
||
| <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"> |
Contributor
There was a problem hiding this comment.
Didn't see this in the PR description so just making sure you intend to include this?
Contributor
Author
There was a problem hiding this comment.
Yes, sorry I didn't add this! I just updated the description to clarify that this was intentionally removed.
1207aa3 to
8288638
Compare
cellomatt
approved these changes
Jul 9, 2026
cellomatt
left a comment
Member
There was a problem hiding this comment.
One tiny thing but this lgtm
Co-authored-by: Matt Kufchak <matt@knock.app>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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"TitleSizeunion type ("p" | "h2" | "h3" | "h4") and typed all component props accordingly so that passing an invalidtitleSizeis now a compile-time error rather than a silent runtime failuredefault: null(which is reverted from the previous version of this PR) as it looks like this was intentional original behavior sinceStepsdefaultstitleSizeto"p"at the prop level, meaningdefaultwas never meant to be reached. With theTitleSizetype now enforced, it genuinely can't be reached, and a comment has been added to reflect thatHeadingsize asSectionHeading(used for ##, ###, #### in MDX via mdxComponents) to help keep the step headings consistent with the rest of the docs.access_tokenstep title insending-a-direct-message.mdxas currently backticks don't render as inline code in the title prop and were displaying as literal characters. Worth us considering adding inline code parsing to the component, but this was the only use of backticks in a title in the docs, so I opted to just remove it from this one use case for now.Tasks
KNO-11556
Screenshots
Before:

After:

Cursor Bugbot found 1 potential issue for commit 48a6f48Can be seen under this section after the "We'll break this function down step-by-step:"