Add clarification to Getting Started docs#2040
Add clarification to Getting Started docs#2040jarednova merged 2 commits intotimber:masterfrom joepetrakovich:master
Conversation
Clarified which directory Composer should be used in. Also added clarification for the scenario of using Composer with the starter theme instead of the WordPress.org install.
Codecov Report
@@ Coverage Diff @@
## master #2040 +/- ##
=========================================
Coverage 95.01% 95.01%
Complexity 1570 1570
=========================================
Files 49 49
Lines 3710 3710
=========================================
Hits 3525 3525
Misses 185 185Continue to review full report at Codecov.
|
|
I'm wondering shouldn't we just make a change in the starter theme so it would use timber as library not as a plugin. Still the documentation here needs 3 variants plugin, lib via composer and plugin via composer. So the changes you made @joepetrakovich should still be included. |
gchtr
left a comment
There was a problem hiding this comment.
Thanks @joepetrakovich! Your additions will make it much clearer how things work 👍.
I agree with @palmiak, we should probably update how the Starter Theme is installed. There’s already an open issue that tracks this.
@jarednova I’ll let you do the final check on this, because you’re the Starter Theme master.
|
You're welcome, and yes I also agree the starter theme should be consistent. What about simply removing the Unless it's better to have a locked Timber version to go with that theme. |
|
I think you're on the right track @joepetrakovich. I still want to make the starter theme versatile to use in either setup. But the |
Clarified which directory Composer should be used in. Also added clarification for the scenario of using Composer with the starter theme instead of the WordPress.org install.
Ticket: #2039
Issue
Trying to use both the Composer install instructions and the starter theme instructions resulted in some confusion when it came to activating the Timber plugin.
Solution
Added clarification for that specific use case.
Impact
Possibly less headaches from new users, less support tickets.
Considerations
It's odd that the starter theme has a composer.json file that is using an older Timber version and uses that package type that installs it as a plugin rather than the Composer autoload mechanism. I'm not really sure the best solution.