-
Notifications
You must be signed in to change notification settings - Fork 116
reorg nav, link refs to usage #1449
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
base: main
Are you sure you want to change the base?
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
| ] | ||
| }, | ||
| { | ||
| "title": "Install providers", |
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.
What do you think about "Use providers", "Configure providers", etc rather than install? To me, "install" feels like the CLI side of things.
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.
To me, installing most closely matches the action, but we can try "Configure providers". I was trying to avoid potential confusion in terms of developing providers. IMO, "Use" is almost always way to generic, but it fits in this case better than most.
rkoron007
left a comment
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.
Approving to unblock, but left a few suggestions in our slack thread!
This PR updates navigation labels for the language docs. We are going to return to a labeling principle based on language construct, instead of JTBD. The second-order principle is to label groups of topics based on workflows. Our North Star principle for creating topics based on information type (Diataxis) is unchanged.
In addition to updating labels and linking to relevant reference pages in the navigation groups, I made sure to cross-link reference pages to usage pages so that people who land on a reference topic from search have an escape hatch to a how-to topic.