Add reference section to CONTRIBUTING.md #577
Conversation
CONTRIBUTING.md
Outdated
| - [Installing Published Packages in Your Redwood App](#Installing-Published-Packages-in-Your-Redwood-App) | ||
| - [Running Your Redwood App's Local Server(s)](#Running-Your-Redwood-App's-Local-Server(s)) | ||
| - [Releases](#Releases) | ||
| - [Contributing](#contributing) |
There was a problem hiding this comment.
Can we eliminate this top-level in the TOC? Feels redundant, especially since it's below the section it's linking.
CONTRIBUTING.md
Outdated
| - [Running Your Redwood App's Local Server(s)](#running-your-redwood-apps-local-servers) | ||
| - [Releases](#releases) | ||
| - [Troubleshooting](#troubleshooting) | ||
| - [Reference](#reference) |
There was a problem hiding this comment.
Let's be more explicit about naming here. Maybe "CLI Reference: redwood-tools". Not sure what that does to the markdown link. But it improves findability.
|
This is looking good!
^^ no way! The current implementation shows you're thinking UX, and in this case specifically the flow/journey of the user. And it's better to that end because of the links. |
|
@thedavidprice updated! |
|
Oh, yeah... 🚢'ing it! @jtoar are you updating the link to the section in the redwoodjs.com CLI reference doc, or should I? Assuming you are but happy to do so otherwise. |
|
@thedavidprice Yes but I almost forgot so thank you for reminding me--coming up! |
Follow up on @redwoodjs/redwoodjs.com #129, this PR adds a Reference section for the
redwood-toolscommand, and links back to the CLI Reference on redwoodjs.com.@thedavidprice One thing I'm concerned about is being too repetitive and self-referential in this doc? But since people might come straight to the Reference section, it might not be a problem to redirect them to sections earlier in the doc because it's all about finding what you want fast?