BenDMyers / showmy.chat

On-demand themed Twitch chat overlay generator

Home Page:https://showmy.chat

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Document some of the Eleventy features we're using and how

BenDMyers opened this issue · comments

Folks are pretty unfamiliar with Eleventy, and this makes things like templating pretty unfamiliar to newcomers!

We should provide a crash course into some of Eleventy's features we're using, namely:

  • Templating
  • Layouts
  • Eleventy Serverless

I had raised a similar concern with you in DMs about this when first getting my head around the code base, so I'm very in favor of including more docs on Eleventy specific topics that are prerequisites for being successful contributing to this project. As someone with beginner-to-intermediate knowledge of Eleventy I was able to get spun up after a few sessions with you, and it actually has helped reinforce my knowledge on the parts of Eleventy I still hadn't quite understood fully.

I already took a crack at the final bullet point with my Eleventy Serverless Documentation discussion thread. I tried to split the difference between explaining the Eleventy core concept, and then specifically applying that terminology to the code contained in showmy.chat.

For Templating and Layouts, I think you could lift a lot of language wholesale from your (definitive and up to date) blog post about the Data Cascade. FWIW, I've found your explanations contained in there actually more clear than the official Eleventy docs. The Eleventy docs are thorough but sparse and they try to let the code speak for itself, which can be challenging if the brief descriptions provided don't quite click for you. To be clear though, I think we should still reference and link to the official docs in addition to our own material.