Skip to content

Instantly share code, notes, and snippets.

@cherta
Created May 9, 2016 03:02
Show Gist options
  • Save cherta/5aa936aade1c44a2510a6388c17b5f73 to your computer and use it in GitHub Desktop.
Save cherta/5aa936aade1c44a2510a6388c17b5f73 to your computer and use it in GitHub Desktop.
OC README feedback

Hi Matteo!

I've been playing with OC and I wanted to share with you how the doc could be improved to help people better grasp the concepts.

I will personally delay explaining how to set up a registry as far as I can in the learning process. To me the dev registry works great for testing the technology and avoids people going to S3, setting up infrastructure, etc.

Another thing I came across while testing is that I understand how to create components but combine them together is not so well explained, I can imagine it is acheived by creating a 'bigger' component, but who knows, maybe I'm missing something.

In conclussion, I will approach the doc the following way:

  1. Show the tech: That's perfectly covered now
  2. Build something with it: Create a couple of useful components if they share state even better (maybe something like a login and a profile box)
  3. Explain, now that you have seen the power of OC how to roll your own registry or event better, point to a gh repo that has the 'deploy to heroku' button. This way I can start publishing in no time.

I would also allow the creation of base components for popular frameworks like react or angular, I know there is a repo with samples but it will be great to do something like: oc init component LoginBox --type react but I understand that could take much longer than writing the docs :).

Ok, sorry for making this so large but my previous job was about supporting big heavy traffic sites with multiple moving parts, marketing changes, A/B testing, etc and I've seen a lot of the problems OC can solve on that scenario so I figure it will be good for you to send some feedback.

Again, thanks for putting OC together, I'll keep testing it! and next time we see we should buy eachother a beer again :)

Cherta

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment