Question: we have CLI development instructions here and here. We probably want one source of truth. Should I consolidate? If so, to packages/CLI/README or /CONTRIBUTING.md? There are valid arguments for both.

Question: The CLI README reads:

This is a monorepo and is published via LernaJS. See the root README for instructions.

The root README does not have these instructions. Are they available anywhere? Should I just delete this section?

Thanks for this.

Your comment about the source of truth made me consider if adding documentation for each command (beyond what we already supply in the description) is valuable? @thedavidprice, maybe you can weight in here?

I can't imagine maintaining this in the README as well.

I think the CLI readme is useful for people who are trying to understand the purpose of this package.

@peterp Great. In writing these docs, I kind of agree.

Perhaps the source of truth for how to use the Redwood CLI should be, well, the Redwood CLI. yarn redwood --help should be verbose enough to be documentation in and of itself (in my opinion).

With that thought, it may also help CLI users to implement some completion shortcuts for commands and options. This indirectly helps with documenting how the CLI is used and will probably be a big gain for developers.

With respect to this current PR, if we think the maintenance of this CLI README is a nightmare and is not very valuable, please don't be afraid to close it. There'll be no hurt feelings. I think a lot of good came out of it already.

@AryanJ-NYC Ok, and thanks! Like you said I don't think this is in vain since you're probably know a bunch about the CLI.

I think a completion shortcut would be amazing! Is there a way that completions can be generated from the commands that they import?

I opened up #311 in response to this.

I'm going to include the [port] fix, thanks for this!

Starting up #322 to continue this conversation

@AryanJ-NYC are you interested in picking this up again? I'm about to take a crack at CLI docs and wanted to loop you in before I started.

@jtoar Nope. Go for it!