-
Notifications
You must be signed in to change notification settings - Fork 337
Re-order kv commands docs to be more user friendly #558
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.
I think the re-ordering of the subcommands is great, but still very, very strongly believe the documentation about --binding/--namespace-id
and --env
should live at the top of this document; otherwise, this very important information gets buried in subcommands.
My general thought is that it's confusing to users when you explain high level concepts before they're ready for them - you don't understand bindings and namespace ids when you have yet to create a namespace in the first place. I agree that this might get buried and cmd+f to a single spot might be difficult. Perhaps we should make a heading called "Getting Started" which just has you create a namespace, and then jump into concepts w/ environments and namespace id/binding explanation, followed by the rest of the doc. |
I like your Getting Started idea! Let's see what Dubs thinks and we can move forward from there :D |
This looks great! |
Co-Authored-By: Kristian Freeman <[email protected]>
Fixes #553