README & getting started guide
Closed this issue · 2 comments
I think we should consider duplicating some of the information on the creating reusable elements guide in the readme of this repo. Would be good to keep them roughly in sync (maybe build part of the guide from the readme here)
@nevir if you could indicate what portion of the reusable elements guide you would like brought in, I can take care of that. I need to update it anyway to account for wct
.
On syncing: for now, a manual sync may be necessary. In future though, we could add fetching the latest readme (or docs file) a part of the release process.
Hmm, I guess I don't have a clear view in my head yet; but here's my rough thought:
The readme would probably benefit from being a TL;DR of that guide. We're sort of doing this with the testing docs in the readme. The develop & test section in the guide is another good candidate for inclusion in the readme. And probably some notes from the create section (about placing it in a "workspace" dir)
(or, we just keep all the info in the guide; but I worry that there's going to be a fair number of people who just drop out of the funnel)