Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
3 tasks
BenDMyers opened this issue Jan 14, 2022 · 1 comment
Open
3 tasks

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

BenDMyers opened this issue Jan 14, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@BenDMyers
Copy link
Owner

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
@BenDMyers BenDMyers added the documentation Improvements or additions to documentation label Jan 14, 2022
@BenDMyers BenDMyers self-assigned this Jan 14, 2022
@ajcwebdev
Copy link
Contributor

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants