wpemerge icon indicating copy to clipboard operation
wpemerge copied to clipboard

Suggestion: An in depth tutorial for newcomers

Open stefanos82 opened this issue 5 years ago • 8 comments

This is a very interesting project, kudos!

As the title says, we definitely need a tutorial that goes in depth following step by step concept.

It would make newcomers feel more than welcome to use it, let alone embrace it.

I will take a look at it and experiment as much as possible.

Keep up the good work :+1:

stefanos82 avatar Mar 13 '19 14:03 stefanos82

Hi @stefanos82 ,

Thank you for the feedback! Could you please share more details about what you'd imagine a tutorial like this would consist of? Note that there are plans for a tutorial series on creating a site from scratch using the starter theme and there are occasional blog posts on specific features but I'm kind of spread thin so to speak so content output is not where I'd like it to be.

atanas-dev avatar Mar 13 '19 15:03 atanas-dev

Well, what I would like to read is either a long, fully detailed tutorial that explains in great detail how this project works with its best practices and important tweaks if there any, or a series of consecutive articles that demonstrate the same thing in order to keep me engaged.

For instance, I'm interested in the following points:

  • how it started
  • why it started
  • what problem(s) does it try to solve
  • what are the best practices (its "Do"s and "Don't"s)
  • which are its limits if there are any
  • how does it compare to Timber plugin
  • which projects, websites, or companies are using it and how they got benefited from using it
  • how productive a developer can become by using this project comparing it with vanilla WP or Timber plugin
  • how to migrate existing themes or WP websites to wpemerge

I cannot think of anything else right now, but I'm sure I will find other things to ask afterwards.

stefanos82 avatar Mar 13 '19 22:03 stefanos82

Information on some of these is available but I will be looking into improving/filling the gaps:

  • how it started / why it started etc. https://wpemerge.com/2018/10/27/what-is-wp-emerge/
  • how does it compare to Timber plugin https://docs.wpemerge.com/#/framework/overview?id=comparison-table-%C2%B9-%C2%B2 https://docs.wpemerge.com/#/starter-theme/overview?id=comparison-table
  • how to migrate existing themes or WP websites to wpemerge Framework integration is incremental and can be used on existing sites without having to rewrite/migrate anything. https://docs.wpemerge.com/#/framework/0-to-100-setup

atanas-dev avatar Mar 15 '19 10:03 atanas-dev

Thank you for letting me know.

I will start reading all this and hopefully to do something useful with it :laughing:

stefanos82 avatar Mar 15 '19 10:03 stefanos82

I would add that there is no comparison to Wordplate, and that there is no example of what a wpemerge project would look like (best documentation is sometimes examples).

Epistol avatar Apr 10 '19 12:04 Epistol

I would add that there is no comparison to Wordplate

@Epistol I am not familiar with Wordplate but from what I'm seeing it's more of an alternative WordPress setup (akin to Bedrock) than a library/starter theme (although it includes some utility functions and Laravel Mix) so they are a different type of project. In fact, I'm pretty sure you can require the WP Emerge framework in a Wordplate project to use its routing, middleware, controllers, views etc.

there is no example of what a wpemerge project would look like

Have you seen the 0-100 setup guide? It provides some insight into how things work together. Also you can check out a simple example site here but keep in mind that it focuses more on the starter theme so it barely uses any of the framework features.

There's obviously more tutorial work to be done but hopefully this can get you started.

atanas-dev avatar Apr 10 '19 13:04 atanas-dev

Please consider adding an architectural overview.

szepeviktor avatar May 23 '20 12:05 szepeviktor

Update: With today's release of 0.16.0 there are now two new docs for newcomers:

What blog post topics are being considered for the near future:

  • A refresher blog post on how WP Emerge can help your project (recent features, benefits outside of routing etc.)
  • Bedrock + WP Emerge step-by-step guide
  • ACF + WP Emerge guide

atanas-dev avatar May 23 '20 22:05 atanas-dev