search

revivek / oy

Render HTML emails on the server with React.
MIT License
834 stars 47 forks source link

Document details about custom template functionality #68

Closed hyu closed 7 years ago

hyu commented 7 years ago

Hi @revivek,

I created this PR to add some more details about how to implement custom templates. I was really struggling to figure out how to use the feature. So I wrote down some notes that would have been helpful to myself.

I really appreciate you creating and maintaining this project. I was feeling daunted by the task of generating a bunch of branded HTML emails, but overall Oy has made it much more pleasant!

Rendez commented 7 years ago

@yuindustries great contribution IMO. However, I think it could be made a bit more concise, since the concept you're explaining is relatively easy to grasp ;)

hyu commented 7 years ago

Thanks, @Rendez. Yes, I was a bit concerned that it was verbose compared to the rest of the README, so I defer to the project maintainer. Use or edit as needed.

That said, I hope my notes are useful insight for someone like you (who had no trouble grasping the concept as documented) to learn more about someone like me (who didn't grasp the concept, and even found the documentation misleading).

Sometimes, when you're deeply familiar with a concept, it can actually make it harder for you to explain it clearly.

revivek commented 7 years ago

Appreciate the contribution, @yuindustries. Happy to add a few more details for using custom templates. As is hopefully obvious, I'm hoping to keep the usage docs digestible via a single README. I left a few comments to that end.

hyu commented 7 years ago

Thanks, @revivek! I looked around for your comments in this PR, but I didn't see any others besides the note you just wrote. Did I miss something?

As a way of making my edits more concise, I hid the code samples in a <details> tag. That way the information is still available, but without adding to the perceived length of your README.

What do you think?

revivek commented 7 years ago

Sorry, I forgot to officially "start" the review! You should be able to see my comments now. With some edits, I don't think we'll need to use the <details> tag.

hyu commented 7 years ago

Hi @revivek — Thank you for the thoughtful and detailed feedback! I made the suggested edits. What do you think of this latest version?

revivek commented 7 years ago

Looks great! Merging.