docs(readme): use h3 headers for options #471
Merged
Conversation
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
Also changed wording of routeParams documentation to indicate dynamic behavior.
There was a problem hiding this comment.
I confirm I suggested we use h4 (or another header) so options can be linked.
I suggest to wait for @Fdawgs feedback before continuing on this PR.
Fdawgs
requested changes
Jul 9, 2025
Co-authored-by: Jean <[email protected]> Signed-off-by: Ben McLean <[email protected]>
|
@jean-michelet and @Fdawgs, I have made the requested changes. Descriptions are now on new-lines and I have used h3 instead of h4. |
jean-michelet
approved these changes
Jul 16, 2025
|
Can you plz merge if you agree @Fdawgs? |
Fdawgs
requested changes
Jul 17, 2025
There was a problem hiding this comment.
Thanks @Ben-at-Catalyst, one last thing, could you sort the indentation please? The indentation of the text and js blocks following these new headers is no longer needed.
Was obviously needed when they were bullet points.
|
Done. @Fdawgs I didn't realize they were just there to make the list blocks work properly :) |
Fdawgs
changed the title
Fdawgs
approved these changes
Jul 21, 2025
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.
I wasn't able to find the
routeParamsoption on the README, I had been searching for "dynamic", "route segment", etc. I opened an issue and was informed of therouteParamsoption.This PR should help future users search for that option as I did.
@jean-michelet Also suggested that I change the options to use h4 headings instead of plain list entries, so that they can be linked, so I've done that here as well.
Closes #465
Checklist
npm run test && npm run benchmark --if-presentand the Code of conduct