-
Notifications
You must be signed in to change notification settings - Fork 1k
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.
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
docs(router): NavLink wording improvements #10380
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Reads like an improvement to me. Left one comment and two minor edits. All small things so feel free to address if you want but optional
docs/docs/router.md
Outdated
<!-- When match "/" --> | ||
<!-- Will match "/" --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The original wasn't clear, but I think the spirit of it is lost if we replace it with just "will". I think "when" was supposed to be short for something like adds "activeLink" when the URL matches "/"
. Maybe we could do will add "activeLink" when the URL matches "/"
?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wanted to keep as close as possible to the existing docs, just make them easier to read and understand.
With that in mind I like your first suggestion best. It's probably more inline with what the original author wanted to express. So I'll go with that for this PR.
That said, it's actually wrong now. But I'll get this merged, and then follow up with a different PR that explains what I mean.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Follow up here: #10401
Co-authored-by: Dominic Saadi <dominiceliassaadi@gmail.com>
…nto feat/register-middleware * 'feat/register-middleware' of github.com:dac09/redwood: docs(router): NavLink wording improvements (redwoodjs#10380)
Co-authored-by: Dominic Saadi <dominiceliassaadi@gmail.com>
Just trying to improve the wording in our docs to make them easier to read and understand